You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Browse filesBrowse the repository at this point in the historyBrowse files
authored
docs: generate the release notes from CHANGELOG.md, and release 1.2.0 (#42)
The release notes were written twice — once in CHANGELOG.md and once as 233
lines of hand-written HTML in docs/src/changelog.html. Nothing kept them in
agreement, so the site could tell someone a fix had shipped when it had not,
which for this project is the same category of problem as a scanner reporting
clean on an infected repository.
CHANGELOG.md is the single source now. docs/changelog-gen.py renders it into
the page's existing markup: releases become sections, "### Fixed — false clean
results" and "### Fixed — destructive behaviour" mark their group and items
critical, (#41) becomes a link to the pull request, and @name becomes a profile
link. Update the changelog in a pull request and the website follows on the
next build — no second edit, and no way to drift.
CI fails if SNARE_VERSION has no matching CHANGELOG.md entry, or if the
generator produces no section for it. A version bump that forgets the changelog
would otherwise publish a page that silently omits the release.
1.2.0 itself is mostly other people's work: the remediation fix from
@phoenixdahdev (#39), which stopped `fix` deleting the build config it was
supposed to repair, and the new campaign it documents — npm's own lib/cli.js
rewritten in place, so every `npm` invocation ran the loader.
Co-authored-by: Avioflagos <ellumainc@gmail.com>
Co-authored-by: Claude Opus 5 <noreply@anthropic.com>
0 commit comments