Skip to content

Lot 14: release notes people can read - #6

Merged
geeooff merged 2 commits into
mainfrom
lot-14-release-notes
Sep 18, 2026
Merged

geeooff merged 2 commits into
mainfrom
lot-14-release-notes

Conversation

@geeooff

@geeooff geeooff commented Sep 18, 2026

Copy link
Copy Markdown
Owner

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.
  • Who writes it, settled: the agent, here, from the commits since the previous tag and the design pages they touch; the maintainer reads it in the release pull request. The release commit is made on the maintainer's machine anyway, with the agent present, so the runner never has to summarise and no placeholder is needed. The rules of a section are in AGENTS.md beside the release procedure.
  • The notes script copies the tag's section onto the release page, keeps the commits below it under For the curious and the checksums last, and refuses a version without a section; build.ps1 release refuses it first, on the machine that can still write it. The changelog's own link definitions are left out of the notes.
  • The changelog joins the link check and the README's table.

What follows this merge: release/0.2.0 — the version bump and [Unreleased] turned into [0.2.0] — then the tag, then v0.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.9 refused
  • .\scripts\build.ps1 release — the new step counts the section's lines; 102 ICEs, release OK
  • test — 26 pages, every link resolves
  • CI

🤖 Generated with Claude Code

geeooff and others added 2 commits September 18, 2026 18:35
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>
@geeooff
geeooff merged commit 624f699 into main Sep 18, 2026
1 check passed
@geeooff
geeooff deleted the lot-14-release-notes branch September 18, 2026 16:53
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.

1 participant