codeaf-changes

Overview ¶

codeaf-changes is the changelog's gate, its scaffold and its typesetter.

THE CHANGELOG IN THIS REPOSITORY IS WRITTEN FOR A MODEL AND NOT FOR A RELEASE PAGE. Its job is not to say what shipped — `git log` says that, and says it better. Its job is to say WHAT SOMEBODY NOW BELIEVES WRONGLY: which branch stopped existing, which default moved, which refusal became a capability. That is the one thing no tool can derive from a diff and the one thing a session opening this repository with a fortnight-old memory of it most needs, so it is the field the format is built around.

It is not shipped. Like cmd/codeaf-demo-home this is a developer's binary and never a verb on codeaf, so it costs the product nothing on the SIZE-BUDGET.

Usage:

codeaf-changes check [dir]                validate every entry
codeaf-changes render <version> [date]    print one version's section
codeaf-changes roll   <version> [date]    render into CHANGELOG.md, then
                                          remove the entries it consumed
codeaf-changes new <kind> <pr> <slug>     scaffold an entry to fill in
codeaf-changes notes <tag>                print one released version's
                                          section, shortened to fit a
                                          GitHub release page