Skip to content

Commit

Permalink
Enforce PRs to link with Issues (#289)
Browse files Browse the repository at this point in the history
Co-authored-by: atmorling <[email protected]>
  • Loading branch information
Yun-Wu and atmorling authored Oct 15, 2024
1 parent 9eee138 commit 819e6b7
Showing 1 changed file with 44 additions and 0 deletions.
44 changes: 44 additions & 0 deletions .github/workflows/link_issue.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
name: Check Linked Issue

on:
pull_request:
types: [opened, reopened, synchronize, edited]

jobs:
check-linked-issue:
runs-on: ubuntu-latest
steps:
- name: Verify Linked Issue
uses: actions/github-script@v6
with:
github-token: ${{secrets.GITHUB_TOKEN}}
script: |
const { pull_request } = context.payload;
const bodyText = pull_request.body || '';
const issuePattern = /(?:close|closes|closed|fix|fixes|fixed|resolve|resolves|resolved)\s+#(\d+)/i;
const match = bodyText.match(issuePattern);
if (!match) {
core.setFailed('No linked issue found in the pull request description.');
return;
}
const issueNumber = parseInt(match[1], 10);
const { owner, repo } = context.repo;
try {
const issue = await github.rest.issues.get({
owner,
repo,
issue_number: issueNumber
});
const minLength = 30; // Minimum description length
if (!issue.data.body || issue.data.body.trim().length < minLength) {
core.setFailed(`Linked issue #${issueNumber} does not have a sufficient description (at least ${minLength} characters required).`);
} else {
console.log(`Linked issue #${issueNumber} has a sufficient description.`);
}
} catch (error) {
core.setFailed(`Issue #${issueNumber} not found or inaccessible.`);
}

0 comments on commit 819e6b7

Please sign in to comment.