M0014 changelog-unreleased¶
Rule: CHANGELOG.md has an Unreleased section.
| Code | M0014 (stable, never reused) |
| Id | changelog-unreleased |
| Category | repo |
| Source | spirit_level |
| Fix | by hand |
Level per tier¶
| Tier | Level | Reason |
|---|---|---|
| small | warn |
work lands under [Unreleased]; the release step turns it into a version section |
| small-workspace | warn |
work lands under [Unreleased]; the release step turns it into a version section |
| medium | warn |
work lands under [Unreleased]; the release step turns it into a version section |
| big | warn |
work lands under [Unreleased]; the release step turns it into a version section |
| ai | off | |
| embedded | off | |
| ui | off | |
| egui | off | |
| units-strict | off | |
| units-paranoid | off |
Why¶
Work commits put their entries under ## [Unreleased]; the release step turns that section into ## [x.y.z] - date. Without the section there is nowhere for a branch to write, and entries end up in the last release by mistake.
How to fix¶
Add ## [Unreleased] above the newest version section.
Configure¶
Allow one finding in the code with // spirit-level: allow(changelog-unreleased) <reason> (waivers); the code works there too, as in [lints.M0014].