Skip to content

docs(release): link the Prepare Python Release PR with addCloseIssueReferences - #5408

Merged
cliffhall merged 1 commit into
v2/mainfrom
v2/docs/5335-release-link-python-pr
Oct 29, 2026
Merged

cliffhall merged 1 commit into
v2/mainfrom
v2/docs/5335-release-link-python-pr

Conversation

@cliffhall

@cliffhall cliffhall commented Oct 29, 2026 •

Copy link
Copy Markdown
Member

Closes #5335

Description

The release skill's step 2c (Prepare Python Release) now links the workflow-opened PR to the release issue with addCloseIssueReferences and reads the link back. It points at the /pr-flow step 6 recipe rather than copying it, and adds a lookup that finds the PR by its v2/chore/<N>-python-calver- branch. The by-hand fallback now says its /pr-flow step 6 does the same link and read-back. RELEASING.md says it next to the Version Packages sentence and in the preparation-PR list.

The workflow itself is unchanged. The issue makes that optional, so this PR keeps to the skill and the doc.

Server Details

  • Server: none (repository-wide)
  • Changes: the release skill (step 2c only) and RELEASING.md

Motivation and Context

On v2/main, a Closes #N line is only a cross-reference. Nothing linked the Prepare Python Release PR through the API, unlike every other PR into v2/main (#5335).

How Has This Been Tested?

This change has no client-observable surface, so the evidence is a targeted probe. I ran the new lookup against past Prepare Python Release PRs, with --state all because they are merged (the skill lists open PRs), and it resolves the PR by its branch prefix. I then read closingIssuesReferences on #5336, the last such PR, which was linked to #5330 by hand. That read is the check the step now asks for:

$ N=5330; gh pr list --base v2/main --state all --limit 300 --json number,headRefName \
    | jq -c --arg p "v2/chore/$N-python-calver-" '.[] | select(.headRefName | startswith($p))'
{"headRefName":"v2/chore/5330-python-calver-2026.10.28","number":5336}
$ gh pr view 5336 --json closingIssuesReferences --jq '[.closingIssuesReferences[].number]'
[5330]

npm run local:gate exits 0. It includes verify:skills and verify:skills:cli. The skill's description is unchanged, so no skills:eval run is needed.

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: release documentation only)
  • 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: nothing published changes)
  • I have tested this with an LLM client (not applicable: no server-facing change; targeted probe above)
  • My code follows the repository's style guidelines
  • New and existing tests pass locally
  • I have added appropriate error handling (not applicable: documentation only)
  • I have documented all environment variables and configuration options (not applicable: none added)

🤖 Generated with Claude Code

…eferences

Step 2c of the release skill now links the workflow-opened PR to the
release issue and reads the link back (the pr-flow step 6 recipe), and
says the by-hand fallback does the same. RELEASING.md says so next to
the Version Packages sentence.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Signed-off-by: cliffhall <cliff@futurescale.com>
@cliffhall cliffhall added the v2 label Oct 29, 2026
@changeset-bot

changeset-bot Bot commented Oct 29, 2026

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: 4227c3e

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 PR description and Closes #5334 claim security-advisory workflow changes that the release-documentation-only diff does not implement.

1 open issue
What changed in this PR

This PR documents explicit release-issue linking for Prepare Python Release PRs, aligning the release procedure with the repository’s v2/main tracking requirements.

Changes:

  • Clarifies that Python release PRs retain Closes #N and also require addCloseIssueReferences.
  • Adds instructions to locate the generated PR, verify its issue link, and wait for dispatched checks before merging.
  • Reinforces issue-link verification in the manual release fallback.
File Description
RELEASING.md Clarifies Python release PR linkage in the release overview.
.claude/​skills/​release/​SKILL.md Adds explicit linking and verification steps for generated and manual Python release PRs.

Review effort: Balanced

Comment on lines +264 to +267
1. **Link it to the release issue.** Its `Closes #N` is only a
cross-reference on `v2/main`, and the workflow makes no API call, so link
it with the `addCloseIssueReferences` mutation from `/pr-flow` (step 6)
and read it back: `closingIssuesReferences` must list `#N`. On `v2/main`

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Fixed (PR body edited; no code change). The body was overwritten by another session's draft for #5334 before the PR was opened: the agents shared a scratch file. The body now starts Closes #5335 and describes this release-documentation change. The API link was always to #5335 only (closingIssuesReferences reads [5335]), so nothing here was recorded against #5334.

@cliffhall

Copy link
Copy Markdown
Member Author

Copilot round 1: one finding, no code changes.

The diff itself drew no findings. The only fix was to the PR body, and no commit was pushed, so there is nothing new for another round to review. The loop stops here.

@cliffhall
cliffhall merged commit f18f7c8 into v2/main Oct 29, 2026
46 checks passed
@cliffhall
cliffhall deleted the v2/docs/5335-release-link-python-pr branch October 29, 2026 05:09
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.

release skill: link the Prepare Python Release PR to the release issue with addCloseIssueReferences

2 participants