Add Signoff CI to Enforce Signoff requirement. #2
Workflow file for this run
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| # | |
| # Copyright (C) 2024 The Draupnir Project | |
| # All rights reserved. | |
| # | |
| # This file is modified and is NOT licensed under the Apache License. | |
| # This modified file incorperates work from matrix-org/backend-meta | |
| # https://github.com/matrix-org/backend-meta | |
| # which included the following license notice: | |
| # | |
| #Copyright 2022 - 2024 The Matrix.org Foundation C.I.C. | |
| # | |
| #Licensed under the Apache License, Version 2.0 (the "License"); | |
| #you may not use this file except in compliance with the License. | |
| #You may obtain a copy of the License at | |
| # | |
| # http://www.apache.org/licenses/LICENSE-2.0 | |
| # | |
| #Unless required by applicable law or agreed to in writing, software | |
| #distributed under the License is distributed on an "AS IS" BASIS, | |
| #WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | |
| #See the License for the specific language governing permissions and | |
| #limitations under the License. | |
| # | |
| # However, this file is modified and the modifications in this file | |
| # are NOT distributed, contributed, committed, or licensed under the Apache License. | |
| # | |
| name: Contribution requirements | |
| on: | |
| pull_request: | |
| types: [opened, edited, synchronize] | |
| workflow_call: | |
| jobs: | |
| signoff: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Check PR for sign-off text | |
| uses: actions/github-script@v6 | |
| with: | |
| script: | | |
| // We don't require owners or members of the org to sign off. | |
| const authorAssociation = context.payload.pull_request.author_association; | |
| if (['OWNER', 'MEMBER'].includes(authorAssociation) || | |
| // GitHub sometimes mislables users as 'CONTRIBUTOR'/'COLLABORATOR', | |
| // so check that the user created the PR on the base project to check they have write access. | |
| context.payload.pull_request.head.user.login === context.repo.owner) { | |
| core.notice('Pull request does not require sign-off.'); | |
| return; | |
| } | |
| // This regex is intentionally left lenient. | |
| const signOffRegex = /signed[_\- ]off[_\- ]by: [\S ]+ <?.+(@|at).+>?/i; | |
| if (signOffRegex.test(context.payload.pull_request.body ?? "")) { | |
| core.notice('Pull request body contains a sign-off notice'); | |
| return; | |
| } | |
| const commits = await github.rest.pulls.listCommits({ | |
| pull_number: context.payload.pull_request.number, | |
| owner: context.repo.owner, | |
| repo: context.repo.repo, | |
| // It's *possible* the author has buried the sign-off 101 commits down, but | |
| // we don't want to max out the API searching for it. | |
| per_page: 100, | |
| }); | |
| const commit = commits.data.find(c => signOffRegex.test(c.commit.message)); | |
| if (commit) { | |
| core.notice(`Commit '${commit.id}' contains a sign-off notice`); | |
| return; | |
| } | |
| core.setFailed('No sign off found. Please ensure you have signed off following the advice in https://the-draupnir-project.github.io/draupnir-documentation/docs/contributing#sign-off .') | |
| core.notice('Ensure you have matched the format `Signed-off-by: Your Name <[email protected]>`') |