|
| 1 | +name: Close Linked Issues |
| 2 | + |
| 3 | +# Auto-close issues referenced with Closes/Fixes/Resolves #N when a PR merges. |
| 4 | +# |
| 5 | +# GitHub's built-in auto-close only fires for PRs merged into the default branch |
| 6 | +# (main). This repo's feature PRs merge into integration branches such as |
| 7 | +# feat/t-replace, so linked issues are otherwise left open. This workflow closes |
| 8 | +# them on any base branch. |
| 9 | +# |
| 10 | +# pull_request_target runs in the base-repo context, so it has an issues:write |
| 11 | +# token even for PRs opened from forks (the normal pull_request event would get |
| 12 | +# a read-only token). It never checks out or runs PR head code, so it is safe. |
| 13 | + |
| 14 | +on: |
| 15 | + pull_request_target: |
| 16 | + types: [closed] |
| 17 | + |
| 18 | +permissions: |
| 19 | + issues: write |
| 20 | + contents: read |
| 21 | + |
| 22 | +jobs: |
| 23 | + close-linked-issues: |
| 24 | + name: Close linked issues |
| 25 | + runs-on: ubuntu-latest |
| 26 | + if: github.event.pull_request.merged == true |
| 27 | + steps: |
| 28 | + - name: Close issues referenced in the PR body |
| 29 | + uses: actions/github-script@v7 |
| 30 | + with: |
| 31 | + script: | |
| 32 | + const pr = context.payload.pull_request; |
| 33 | + const body = pr.body || ''; |
| 34 | +
|
| 35 | + // Match "<keyword> #123" / "<keyword>: #123", keyword case-insensitive. |
| 36 | + const keyword = '(?:close[sd]?|fix(?:e[sd])?|resolve[sd]?)'; |
| 37 | + const re = new RegExp(`${keyword}\\s*:?\\s+#(\\d+)`, 'gi'); |
| 38 | +
|
| 39 | + const numbers = new Set(); |
| 40 | + for (const m of body.matchAll(re)) { |
| 41 | + numbers.add(Number(m[1])); |
| 42 | + } |
| 43 | +
|
| 44 | + if (numbers.size === 0) { |
| 45 | + core.info('No "Closes/Fixes/Resolves #N" references found in the PR body.'); |
| 46 | + return; |
| 47 | + } |
| 48 | +
|
| 49 | + for (const issue_number of numbers) { |
| 50 | + try { |
| 51 | + const { data: issue } = await github.rest.issues.get({ |
| 52 | + owner: context.repo.owner, |
| 53 | + repo: context.repo.repo, |
| 54 | + issue_number, |
| 55 | + }); |
| 56 | +
|
| 57 | + // Skip PRs (the API treats PRs as issues) and already-closed issues. |
| 58 | + if (issue.pull_request) { |
| 59 | + core.info(`#${issue_number} is a pull request, skipping.`); |
| 60 | + continue; |
| 61 | + } |
| 62 | + if (issue.state === 'closed') { |
| 63 | + core.info(`#${issue_number} is already closed, skipping.`); |
| 64 | + continue; |
| 65 | + } |
| 66 | +
|
| 67 | + await github.rest.issues.createComment({ |
| 68 | + owner: context.repo.owner, |
| 69 | + repo: context.repo.repo, |
| 70 | + issue_number, |
| 71 | + body: `Closed by #${pr.number} (merged into \`${pr.base.ref}\`).`, |
| 72 | + }); |
| 73 | + await github.rest.issues.update({ |
| 74 | + owner: context.repo.owner, |
| 75 | + repo: context.repo.repo, |
| 76 | + issue_number, |
| 77 | + state: 'closed', |
| 78 | + state_reason: 'completed', |
| 79 | + }); |
| 80 | + core.info(`Closed #${issue_number}.`); |
| 81 | + } catch (err) { |
| 82 | + core.warning(`Could not close #${issue_number}: ${err.message}`); |
| 83 | + } |
| 84 | + } |
0 commit comments