|
name: Check for Spammy Issues |
|
|
|
# **What it does**: This action closes low value pull requests in the open-source repository. |
|
# **Why we have it**: We get lots of spam in the open-source repository. |
|
# **Who does it impact**: Open-source contributors. |
|
|
|
on: |
|
issues: |
|
types: [opened] |
|
|
|
permissions: |
|
contents: read |
|
|
|
jobs: |
|
spammy-title-check: |
|
name: Remove issues with spammy titles |
|
if: github.repository == 'github/docs' |
|
runs-on: ubuntu-latest |
|
steps: |
|
- uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 |
|
with: |
|
github-token: ${{ secrets.DOCS_BOT_PAT_BASE }} |
|
script: | |
|
|
|
const issue = context.payload.issue |
|
const owner = 'github' |
|
const repo = 'docs' |
|
|
|
const titleWordCount = issue.title.trim().split(' ').length |
|
const titleWordCountMin = 3 |
|
|
|
try { |
|
await github.rest.teams.getMembershipForUserInOrg({ |
|
org: 'github', |
|
team_slug: 'employees', |
|
username: context.payload.sender.login, |
|
}); |
|
|
|
// Do not perform this workflow with GitHub employees. This return |
|
// statement only gets hit if the user is a GitHub employee |
|
return |
|
} catch (err) { |
|
// An error will be thrown if the user is not a GitHub employee |
|
// If a user is not a GitHub employee, we should check to see if title has at least the minimum required number of words in it and if it does, we can exit the workflow |
|
|
|
if (titleWordCount >= titleWordCountMin) { |
|
return |
|
} |
|
} |
|
|
|
// |
|
// Assuming the user is not a GitHub employee and the issue title |
|
// does not contain the minimum number of words required, proceed. |
|
// |
|
|
|
// Close the issue and add the invalid label |
|
await github.rest.issues.update({ |
|
owner: owner, |
|
repo: repo, |
|
issue_number: issue.number, |
|
labels: ['invalid'], |
|
state: 'closed' |
|
}); |
|
|
|
// Comment on the issue |
|
await github.rest.issues.createComment({ |
|
owner: owner, |
|
repo: repo, |
|
issue_number: issue.number, |
|
body: `This issue may have been opened accidentally. I'm going to close it now, but feel free to open a new issue with a more descriptive title!` |
|
}); |
|
|
|
// Add the issue to the Done column on the triage board |
|
try { |
|
await github.rest.projects.createCard({ |
|
column_id: 11167427, |
|
content_id: context.payload.issue.id, |
|
content_type: "Issue" |
|
}); |
|
} catch (error) { |
|
console.log(error); |
|
} |
