Skip to content

feat(ci): fail PR Body Check when a Fixes issue is not linked in Development - #5139

Merged
dgibbs64 merged 1 commit into
developfrom
ci/pr-body-link-check
Nov 1, 2026
Merged

dgibbs64 merged 1 commit into
developfrom
ci/pr-body-link-check

Conversation

@dgibbs64

@dgibbs64 dgibbs64 commented Nov 1, 2026 •

Copy link
Copy Markdown
Member

Description

PR Body Check now fails when the body names an issue with a closing keyword (Fixes, Closes or Resolves #N) that is not linked in the pull request's Development section.

Closing keywords only create a Development link on pull requests into the default branch (master). On pull requests into develop they never link, so the issue's sidebar stays empty unless someone links it by hand, and that step was regularly missed: 14 open issues waiting for v26.5.0 had a merged Fixes PR with no link.

  • Reads the PR's closingIssuesReferences (which includes manual links) and compares it with the issue numbers after closing keywords in the body.
  • Ignores references to other repositories and numbers that are pull requests, not issues.
  • Related to #N and pull requests with no issue are unchanged: they still only get a warning.
  • Linking an issue in the sidebar does not re-trigger the workflow, so the error says to re-run the check after linking.
  • Adds issues: read and pull-requests: read to the workflow token for the GraphQL lookups.

No linked issue: this is maintenance found while auditing issue links.

Affected servers: none (CI only)

Type of change

  • Bug fix (a change which fixes an issue).
  • New feature (a change which adds functionality).
  • New Server (new server added).
  • Refactor (restructures existing code).
  • Chore (CI, workflows, tooling or other maintenance).
  • Comment update (typo, spelling, explanation, examples, etc).

Testing

Checklist

PR will not be merged until all steps are complete.

  • This pull request links to an issue ("Fixes", or "Related to" for a partial fix). (No issue: maintenance.)
  • This pull request uses the develop branch as its base.
  • This pull request subject follows the Conventional Commits standard.
  • This code follows the style guidelines of this project.
  • I have performed a self-review of my code.
  • I have provided a detailed enough description of this PR.

…lopment

Closing keywords never create a Development link on pull requests into develop, so the link has to be added by hand and was often missed. The check now compares the issues named after Fixes, Closes or Resolves with the pull request's closingIssuesReferences and fails on any issue that is not linked. Related to and no-issue pull requests still only warn.
@dgibbs64 dgibbs64 added this to the v26.5.0 milestone Nov 1, 2026
@github-actions github-actions Bot added the type: feature New feature or request label Nov 1, 2026
@dgibbs64
dgibbs64 merged commit a3e0960 into develop Nov 1, 2026
46 of 47 checks passed
@dgibbs64
dgibbs64 deleted the ci/pr-body-link-check branch November 1, 2026 20:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

type: feature New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant