docs(release): the CHANGELOG section is written at cut time — policy follows practice - #89
Merged
Merged
Conversation
…follows practice R2 said every PR appends to a standing `## [Unreleased]` section that the cut renames. Practice had settled on cut-time authoring: HEAD carries no such section, and the release-cut PR writes `## [X.Y.Z] - YYYY-MM-DD` from `git log <lastTag>..HEAD`. R2, the version table row and R6 steps 2–3 now say so, and the cut PR must list the range it covers. Same edit as o3co/auth.provider#475. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
There was a problem hiding this comment.
🟡 Changes recommended
Two documented nit issues remain unresolved.
Once you've addressed the issues Copilot identified, you can request another Copilot review.
Pull request overview
Updates the shared release policy to document cut-time CHANGELOG authoring instead of a standing Unreleased section.
Changes:
- Revises R2 and R6 for release-section generation from the commit range.
- Updates release-cut checklist and review guidance.
- Documents the rationale for the policy change.
File summaries
| File | Summary | Findings |
|---|---|---|
docs/release-policy.md |
Updates CHANGELOG and release-cut procedures. |
Two nit comments: align heading punctuation with repository conventions (3 votes) and qualify the auth.provider#475 reference (1 vote). |
Review details
Suppressed comments (1)
docs/release-policy.md:56
- This shared policy is hosted in
auth.proxy, but the parenthetical(#475)is theauth.providerchange referenced by the PR description. In Markdown that bare reference is ambiguous and will point readers at this repository's issue/PR 475 instead of the source decision; use a fully qualified link or nameo3co/auth.provider#475explicitly.
The earlier wording of this rule had every PR append to a standing `## [Unreleased]` section. Practice in every repository that shares this policy had settled on cut-time authoring — HEAD never carried the section, and the cut PR wrote it from the log — so the rule now says what is done (#475). The cost is that a change merged mid-cycle has no CHANGELOG trace until the cut; the range listed in the cut PR is the compensating control, and a reviewer who cannot tick every operator-visible commit against an entry blocks the cut.
- Files reviewed: 1/1 changed files
- Comments generated: 1
- Review effort level: Lite
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
…eading separator convention Review of #89. R2 names the repository-level `CHANGELOG.md` as its subject, and says the heading's version/date separator is whatever the repository's CHANGELOG already uses — this repository's is an em dash while the shared policy text writes a hyphen in its examples — and that a release workflow matches on `## [X.Y.Z]` alone. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The shared release policy's R2 said every PR appends to a standing
## [Unreleased]section that the cut renames; practice in this repository (and every sibling) is that HEAD carries no such section and the release-cut PR writes## [X.Y.Z] - YYYY-MM-DDfromgit log <lastTag>..HEAD. This is the same policy edit as o3co/auth.provider#475 (option b): R2 describes cut-time authoring and requires the cut PR to list the range it covers so completeness can be reviewed; the version table row and R6 steps 2–3 follow. No behaviour changes; documentation only.🤖 Generated with Claude Code