Skip to content

Test PR, please ignore #158

Test PR, please ignore

Test PR, please ignore #158

Workflow file for this run

name: Contribution requirements
on:
pull_request:
types: [opened, edited, synchronize]
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;
core.notice('Pull request body:', context.payload.pull_request.body)
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://matrix-org.github.io/synapse/latest/development/contributing_guide.html#sign-off .')
core.notice('Ensure you have matched the format `Signed-off-by: Your Name <[email protected]>`')
core.notice('If you have signed off privately instead (following the steps in Private Sign off), you can ignore this test.')