release/changelog-in-release
Release notes are generated from commits
| Severity | info |
| Tiers | 1 |
| Stacks | any |
| Scope | root |
| Kind | outcome |
| Source | library v0.8.0 |
| Selected by | fleetlint-recommended@v0.8.0 |
Requirement
Release notes come from git-cliff, GoReleaser’s changelog, release-please, changesets, or the release’s own section cut from the generated CHANGELOG.md, so they match the CHANGELOG.
Why
Hand-written release notes drift from the changelog and from what was shipped.
Applies when
release.exists && tagged_workflows().size() > 0Fix
Use git-cliff –latest –strip header as the release body.
Agent instruction: Add a step that runs git-cliff --latest --strip header -o release-notes.md and pass it as the release body.
A finding that names no file points at the first workflow a tag push starts, or .github/workflows/release.yml when there is none.
Sources
- https://keepachangelog.com/en/1.1.0/ (standard, How do I make a good changelog?)
- https://fleetlint.org/baseline/#releases (convention)
Generated by fleetlint docs from catalog v0.8.0.