Repository navigation
docs: keep a CHANGELOG and publish each release's section as its notes - #108
Merged
Merged
Conversation
iamnbutler
force-pushed
the
chore/changelog
branch
from
October 17, 2026 09:17
252dfce to
b3aa827
Compare
iamnbutler
force-pushed
the
chore/changelog
branch
from
October 17, 2026 09:22
b3aa827 to
cd34fa7
Compare
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.
Adds
CHANGELOG.mdand uses it for release notes from now on.chore: releasecommits. Entries are short user-facing bullets under Added, Changed and Fixed, with PR links.[Unreleased]section covers what's on main now: feat: list recent agent activity in the app's menu #98, feat: paste an image or files into a native text area with desktop_insert, or leave the clipboard replaced on request #99, feat: pause all input from the app menu #100, feat: select the input source through the host #101, chore: run the automatable #42 live checks with npm run live-check #102 and docs: halve the MCP tool list and state the shared rules once #103.scripts/changelog.ts [version]prints one version's section without its heading. It fails when the section is missing or has no bullets.npm run check, so a missing entry stops the run before the 90-minute signed build. It publishes with--notes-fileinstead of--generate-notes.test/changelog.test.mjsfails unless package.json's version has a dated section with entries and a compare link, and an[Unreleased]heading exists. A version bump without a CHANGELOG entry therefore failsnpm test. It also tests the section parser.gh workflow run release.yml -f publish=true.The GitHub release bodies for v0.2.0 through v0.10.0 are edited separately with
gh release edit. Each gets its section, followed by the existing Full Changelog compare link. All the previous bodies were entirely auto-generated ("What's Changed" PR lists); I checked them line by line before replacing them and kept backups.npm test(61 tests) andnpm run checkpass.