Improve project management (follow-up) #9
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
name: Enforce linking issues | |
on: | |
pull_request_target: | |
types: [opened, edited, labeled] | |
workflow_call: | |
defaults: | |
run: | |
shell: bash | |
jobs: | |
main: | |
name: Enforce referencing a closing issue | |
runs-on: ubuntu-latest | |
steps: | |
- name: Count closing issue references | |
id: has-closing-issue | |
uses: actions/github-script@v7 | |
with: | |
result-encoding: string | |
script: | | |
const query = `query ($owner: String!, $name: String!, $number: Int!) { | |
repository(owner: $owner, name: $name) { | |
pullRequest(number: $number) { | |
closingIssuesReferences(first: 100) { | |
totalCount | |
} | |
} | |
} | |
}`; | |
const reply = await github.graphql(query, { | |
owner: context.repo.owner, | |
name: context.repo.repo, | |
number: context.payload.pull_request.number | |
}); | |
return reply | |
.repository | |
.pullRequest | |
.closingIssuesReferences | |
.totalCount > 0; | |
- if: ${{ steps.has-closing-issue.outputs.result != 'true' }} | |
name: Suggest that the contributor link an issue | |
uses: actions/github-script@v7 | |
with: | |
github-token: ${{ secrets.BOT_TOKEN_WORKFLOW }} | |
script: | | |
const login = "${{ github.event.pull_request.user.login }}"; | |
const syntaxUrl = "https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue"; | |
const message = `@${login} Please consider linking this pull request to an issue using \`Closes #ISSUE-NUMBER\` [syntax](${syntaxUrl}), \ | |
especially if this pull request contains a bugfix, an enchancement or a new feature.`; | |
github.rest.issues.createComment({ | |
owner: context.repo.owner, | |
repo: context.repo.repo, | |
issue_number: context.payload.pull_request.number, | |
body: message, | |
}); | |
core.setFailed("This pull request has no linked issue") |