Lot 14: release notes people can read - #6
Merged
Merged
Conversation
The release page said "First public release" over a list of commits: a changelog for the people who wrote them, not for the person who clicked What changed. CHANGELOG.md now carries a section per version in Keep a Changelog's shape, each line something the user can see or do, written by the agent from the commits and the design pages and read by the maintainer as a diff -- the release commit is made on the maintainer's machine anyway, with the agent present, so the runner never has to summarise. The notes script copies the tag's section onto the release page, keeps the commits below it for the curious and the checksums last, and refuses a version without a section; the release build refuses it first. The rules of a section are in AGENTS.md. The sections for 0.1.0 and for what 0.2.0 will carry are written. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
The changelog keeps the date of each release commit so the file reads on its own, without the release page. A heading without one is refused the way a missing section is: by the release build here first, and by the workflow's notes script. Co-Authored-By: Claude Opus 5 <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.
Summary
The release page said First public release over a list of commits — a changelog for the people who wrote them, not for the person who clicked What changed. Design record in
docs/design/14-release-notes.md.CHANGELOG.md, one section per version in Keep a Changelog's shape, each line something the person running the program can see or do. The sections for 0.1.0 and for what 0.2.0 will carry ([Unreleased]) are written — read them as the diff they are.AGENTS.mdbeside the release procedure.build.ps1 releaserefuses it first, on the machine that can still write it. The changelog's own link definitions are left out of the notes.What follows this merge:
release/0.2.0— the version bump and[Unreleased]turned into[0.2.0]— then the tag, thenv0.1.0's notes rewritten once with its section, on approval.Test plan
.\scripts\release-notes.ps1 -Tag v0.1.0— the 0.1.0 section, the commits, the sums;v9.9.9refused.\scripts\build.ps1 release— the new step counts the section's lines; 102 ICEs,release OKtest— 26 pages, every link resolves🤖 Generated with Claude Code