docs: a port's PR title is its CHANGELOG entry (runbook Step 4.5, ADR 0003 D8) - #45
Merged
Merged
Conversation
Runbook Step 4.5 said to append a CHANGELOG.md entry by hand, but the file is generated at release by eng/update-changelog.ps1 from the GitHub release notes (PR titles), inserted below <!-- next-release -->. There is no unreleased section to append to. Decided during upstream sync #1 (#28). Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
D8 said a port adds a CHANGELOG.md entry, but the file is generated at release from merged PR titles and has no unreleased section to add to. D8 now matches runbook Step 4.5, with an amendment note under Status. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
iancooper
changed the title
This was referenced Sep 28, 2026
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 subscribe to this conversation on GitHub.
Already have an account?
Sign in.
1 participant
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.
Fixes a runbook defect found during upstream sync #1. Refs #28.
Step 4.5 of
.agent_instructions/upstream_sync.mdsaid to "append aCHANGELOG.mdentry" for each port. ButCHANGELOG.mdis generated at release:after-release.ymlrunseng/update-changelog.ps1, which builds the version's section from the GitHub release notes (one bullet per merged PR title) and inserts it below<!-- next-release -->. There's no unreleased section to append to, and a hand edit would sit outside any version heading.Step 4.5 now says:
CHANGELOG.md.This follows the decision recorded on #28. Ports #42, #43 and #44 already work this way.
ADR 0003 D8 is amended to match. It said a port "adds a
CHANGELOG.mdentry". It now says the PR title is the entry and ports don't hand-edit the file. An amendment note under## Statusrecords what changed and why. This is the first ADR amendment in the repo: it keepsAcceptedand adds a dated note, following the convention in.claude/commands/adr/write_adr_metadata.md.markdownlint is clean. pyspelling reports nothing new (its only hits are the gitignored
PROMPT.mdandbaseline/README.md).🤖 Generated with Claude Code