-
-
Notifications
You must be signed in to change notification settings - Fork 17.1k
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
Closed
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
Explain the rationale behind the changes and remove this line. |
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
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.", | ||
}); | ||
|
||
// Close the PR | ||
await github.rest.pulls.update({ | ||
owner: context.repo.owner, | ||
repo: context.repo.repo, | ||
pull_number: pull_request.number, | ||
state: "closed", | ||
}); | ||
} |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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
There was a problem hiding this comment.
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.