Documentation
¶
Overview ¶
Command release-notes renders the operator-facing changelog for a given release version from the embedded release notes (pkg/releasenotes/notes.yaml) and writes it to a file, for use as the GitHub release body.
The Release workflow runs this on a tag push and points GoReleaser's --release-notes flag at the output, so the GitHub release description is the same curated note that drives the in-app "What's new" popup -- not GoReleaser's git-derived changelog, which lists every commit when the previous release tag is not an ancestor of the tagged commit.
go run ./cmd/release-notes -version 0.14.0 -out release-notes.md
Unlike play-whatsnew, the output is NOT truncated: the GitHub release body has no tight length limit, so the full note ships. Exits non-zero if no note exists for the version, so a release with a missing changelog entry fails loudly rather than shipping a blank body.
Source Files