changelog/present
CHANGELOG.md exists
| Severity | warning |
| Tiers | 1, 2 |
| Stacks | any |
| Scope | root |
| Kind | expr |
| Source | library v0.7.0 |
| Selected by | fleetlint-recommended@v0.7.0 |
Requirement
The repository keeps a CHANGELOG.md with one ## section per version (## [Unreleased] until the first release), as Keep a Changelog, git-cliff, release-please and changesets write it.
Why
Users and future you need to know what changed between versions without reading commits.
Check
file("CHANGELOG.md") && scan("CHANGELOG.md", "^##\\s+\\S").size() > 0Fix
Add CHANGELOG.md with an ## [Unreleased] section (fleetlint fix --apply writes it), then keep it current with git-cliff.
Agent instruction: Create CHANGELOG.md from the template; if cliff.toml exists, regenerate it with git-cliff -o CHANGELOG.md and review the result.
fleetlint fix can apply this rule’s fix automatically (1 action(s)).
A finding of this rule points at CHANGELOG.md.
Sources
- https://keepachangelog.com/en/1.1.0/ (standard, How do I make a good changelog?)
- https://fleetlint.org/baseline/#releases
Generated by fleetlint docs from catalog v0.7.0.