Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ci: detect Spam pull requests in GitHub Actions #5480

Closed
wants to merge 2 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Explain the rationale behind the changes and remove this line.
63 changes: 63 additions & 0 deletions .github/workflows/spam.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
name: Spam Check

on:
pull_request:
types: [opened, synchronize]

jobs:
check:
runs-on: ubuntu-latest
permissions:
pull-requests: write
steps:
- uses: actions/github-script@v7
with:
script: |
const pull_request = context.payload.pull_request;

if (pull_request === undefined) {
console.log("This is not a pull request");
return;
}

const prOpener = pull_request.user.login;

const { data: contributions } = await github.rest.repos.listContributors({
owner: context.repo.owner,
repo: context.repo.repo,
});

const prOpenerContributions = contributions.find(
(contributor) => contributor.login === prOpener
);

if (
prOpenerContributions !== undefined &&
prOpenerContributions.contributions > 0
) {
console.log("the PR opener has previous contributions");
return;
}

// If the PR opener is not a contributor, check if the body is empty or it contains the default message
const body = pull_request.body;

const defaultMessage = "Explain the rationale behind the changes and remove this line"

if (!body || body.includes(defaultMessage)) {
// Add a comment to the PR
await github.rest.issues.createComment({
owner: context.repo.owner,
repo: context.repo.repo,
issue_number: pull_request.number,
body: "Closing this PR because it does not follow the contribution guidelines.",
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You probably want to elaborate this a bit more by providing helpful links.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

When they ignore the clear short message in the template, I am not sure adding more information helps

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This closing comment is fine. You don't need to add any links. Anyone worth their salt will know how to look up Contribution Guidelines in GitHub.

I'd suggest a longer PR template instead. One that really requires a person to read through the template and fill it out properly.

});

// Close the PR
await github.rest.pulls.update({
owner: context.repo.owner,
repo: context.repo.repo,
pull_number: pull_request.number,
state: "closed",
});
}