Skip to content

docs(release): the CHANGELOG section is written at cut time — policy follows practice - #89

Merged
y1o1 merged 2 commits into
developfrom
docs/release-policy-cut-time
Sep 11, 2026
Merged

y1o1 merged 2 commits into
developfrom
docs/release-policy-cut-time

Conversation

@y1o1

@y1o1 y1o1 commented Sep 11, 2026

Copy link
Copy Markdown
Contributor

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-DD from git 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

…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>
Copilot AI lite review requested due to automatic review settings September 11, 2026 11:52

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

🟡 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 the auth.provider change 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 name o3co/auth.provider#475 explicitly.
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.

Comment thread docs/release-policy.md
…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>
@y1o1
y1o1 merged commit f7258a2 into develop Sep 11, 2026
1 check passed
@y1o1
y1o1 deleted the docs/release-policy-cut-time branch September 11, 2026 12:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants