Skip to content

docs: link the Version Packages PR to its release issue, not only by comment - #5221

Merged
cliffhall merged 3 commits into
v2/mainfrom
v2/docs/5164-version-packages-link
Oct 22, 2026
Merged

cliffhall merged 3 commits into
v2/mainfrom
v2/docs/5164-version-packages-link

Conversation

@cliffhall

Copy link
Copy Markdown
Member

Closes #5164

Description

The changesets "Version Packages" PR was tied to its milestone's release issue by a Part of #N comment only. A comment is not a link: the PR showed no linked issue and the release issue listed nothing (v2.0.0's #5100 was linked to #5159 by hand after it merged). This brings it in line with every other PR, adjusted for the action rewriting its body:

  1. Linked with addCloseIssueReferences as soon as the PR is found. The link lives outside the body, so the rewrites on each push to v2/main don't remove it, and on v2/main it closes nothing at merge.
  2. Part of #N becomes the body's first line immediately before merging, after the last regeneration, and is checked to still be there at merge (repeat if a push regenerated the body).
  3. The Part of #N comment stays as the durable textual record.

Changed together:

  • AGENTS.md: the rule (Contributing → Exception: the two version PRs that automation opens).
  • .claude/skills/release/SKILL.md step 2b: the recipe (link + comment in step 1; the new steps 4 and 5 prepend the line and check it before the merge).
  • RELEASING.md: its two descriptions of how the Version Packages PR references the release issue (per the maintenance rule on versioning/publishing docs).

docs/agent-guidance-inception.md is left alone: it's the historical inception record.

Server Details

None (repository-wide): docs and the release skill only.

Motivation and Context

See #5164.

How Has This Been Tested?

No client-observable surface, so I ran targeted probes of the new recipe, read-only, against v2.0.0's Version Packages PR #5100 (release issue #5159):

  • Link read-back, as step 1 reads it via /pr-flow: gh pr view 5100 --json closingIssuesReferences --jq '[.closingIssuesReferences[].number]' → [5159].
  • Step 5's first-line check: gh pr view 5100 --json body --jq '.body | split("\n")[0]' → Part of #5159.
  • Step 4's prepend, written to a temp file and not applied: the output starts Part of #5159, then a blank line, then the original body intact (47 → 49 lines).

npm run local:gate exits 0 under Node 24.22.1 (the development version). On Node 26.7.0 it fails in one memory test, persistence.test.ts › reports a graph file that cannot be read as a tool error. That failure is already tracked in #5162, comes from v2/main, and this Markdown-only diff doesn't touch it. Every other stage passed on 26.7 too.

Breaking Changes

None.

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Documentation update

Checklist

  • I have read the MCP Protocol Documentation (not applicable: no protocol surface touched)
  • My changes follow MCP security best practices (not applicable: no server code)
  • I have updated the server's README accordingly (not applicable: no server changed)
  • I have added a changeset (npm run changeset) if this changes what a TypeScript server publishes (not applicable: publishes nothing)
  • I have tested this with an LLM client (not applicable: no server-facing change; targeted probes above)
  • My code follows the repository's style guidelines
  • New and existing tests pass locally (gate green on Node 24; see above for Node 26.7 / memory: persistence EISDIR test fails on macOS (the path suffix depends on the platform, not the Node version) #5162)
  • I have added appropriate error handling (not applicable: docs only)
  • I have documented all environment variables and configuration options (not applicable: none added)

🤖 Generated with Claude Code

…comment

The Version Packages PR is linked with addCloseIssueReferences as soon as
it is found, carries Part of #N as its body's first line immediately
before merging, and keeps the Part of #N comment as the durable record.

Closes #5164

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Signed-off-by: cliffhall <cliff@futurescale.com>
@changeset-bot

changeset-bot Bot commented Oct 22, 2026 •

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: bbba2c4

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟡 Changes recommended

The body-update recipe can overwrite generated release notes after a failed read unless the edit is guarded.

1 open issue
What changed in this PR

Updates the release documentation and procedure for #5164 so the changesets “Version Packages” PR has a persistent link to its release issue, rather than only a comment.

Changes:

  • Require addCloseIssueReferences when the version PR is found.
  • Retain the durable Part of #N comment.
  • Add and verify a Part of #N first body line immediately before merging.
File Description
RELEASING.md Aligns both release-process descriptions with the linking procedure.
AGENTS.md Updates the Version Packages exception to require the link and pre-merge body line.
.claude/​skills/​release/​SKILL.md Adds linking, body-editing, and pre-merge verification steps.

Review effort: Balanced

Comment thread .claude/skills/release/SKILL.md Outdated
… read

A failed gh pr view must not let gh pr edit replace the generated release
notes with the Part of prefix alone (Copilot, #5221).

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Signed-off-by: cliffhall <cliff@futurescale.com>
@cliffhall

Copy link
Copy Markdown
Member Author

Copilot round 1: one finding.

  • Guard the body edit against a failed read (.claude/skills/release/SKILL.md): fixed in 4a51981. The edit now runs only after a successful, non-empty gh pr view. Both paths were probed, and the gate still exits 0.

Requesting round 2.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟢 Approval recommended

The changes consistently implement #5164, address the prior body-update safeguard feedback, and leave no unresolved blocking issues.

No open issues 🎉

1 resolved since last review

Review effort: Balanced

@cliffhall

Copy link
Copy Markdown
Member Author

Copilot round 2: clean ("No open issues"; the round-1 finding is marked resolved). The review loop stops on this first clean round.

…on-packages-link

Signed-off-by: cliffhall <cliff@futurescale.com>

# Conflicts:
#	RELEASING.md
@cliffhall
cliffhall merged commit 69b53e9 into v2/main Oct 22, 2026
40 checks passed
@cliffhall
cliffhall deleted the v2/docs/5164-version-packages-link branch October 22, 2026 20:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Version Packages PR: link it to the release issue with addCloseIssueReferences and a Part of line, not only a comment

2 participants