E5 Changelog & release notes
- Area
- E — Maintenance
- Audience
- operator
- Kind
- feature
- Status
- accepted
- Maturity
- shipped
- Shipped in
- 0.14.0
- Labels
- updates, verification
The feature in the specification · Read at
Requirements
Every release MUST have changelog notes, and they MUST be generated from that release's commits rather than hand-maintained.
- locked by
- 0.14.0 met
- recorded done
- lemonfibercliff.toml.github/workflows/release-changelog.yml
- cited by
- lemonfiber@8b066641e3
The generator MUST NOT include a change that did not ship, and MUST NOT omit a change that did.
- locked by
- 0.14.0 uncited
- recorded done
- lemonfibercliff.toml.github/workflows/release-changelog.yml
Each entry MUST identify the feature area it belongs to and link the requirement it satisfied.
- locked by
- 0.14.0 met
- recorded done
- lemonfiberscripts/the_requirements_an_entry_names.py
- cited by
- lemonfiber@7f3486df60
Each entry MUST link the version that shipped it, and a requirement spanning several releases MUST link each.
A commit that cites no requirement MUST still appear, grouped as maintenance, so the record is complete.
- locked by
- 0.14.0 met
- recorded done
- lemonfibercliff.tomlscripts/the_record_a_release_leaves.py
- cited by
- lemonfiber@d852da61ef
The changelog MUST be shown in the self-update and stack-update flows, not only on a release page.
- locked by
- 0.14.0 met
- recorded done
- lemonfibercrates/lemonfiber/src/render/self_update.rscrates/lemonfiber/src/render/update.rscrates/lemonfiber-core/src/self_update/offered.rscrates/lemonfiber-core/src/changelog.rs
- recorded partial
- lemonfiber-companionapp-modules/kernel/src/Api/Release.phpapp-modules/kernel/src/Api/WhatAReleaseDelivers.phptests/Contract/KeepingCurrentContractTest.phptests/Support/WhatThisAppDoesNotRead.php
- cited by
- lemonfiber@e28022c190
A patch/hotfix release MUST appear with its cited fix, against the version it patched.
A yanked release MUST appear marked withdrawn with its reason, and MUST NOT be removed from the record.
- locked by
- 0.14.0 met
- recorded done
- lemonfiber.github/workflows/release-withdraw.yml
- cited by
- lemonfiber@d852da61ef
Entries MUST lead with a plain-language summary; identifiers MUST be the link target, not the headline (G2).
A release with no user-facing change MUST be stated as such rather than emitted as an empty release.
When the generated changelog and the release tags disagree, the changelog MUST be flagged stale and MUST NOT be presented as current.
- locked by
- 0.14.0 met
- recorded done
- lemonfibercrates/lemonfiber-core/src/changelog.rsreference/changelog/scripts/the_record_a_release_leaves.py.github/workflows/build.yml
- cited by
- lemonfiber@1087eb1da1lemonfiber@18a698102clemonfiber@2070cf0481lemonfiber@8b066641e3lemonfiber@e949a71e0flemonfiber@387f0c83c5
A requirement withdrawn after it shipped MUST retain its historical entry; the withdrawal MUST be recorded, not erased.
- locked by
- 0.14.0 met
- recorded done
- lemonfiber.github/workflows/release-changelog.ymlscripts/the_record_a_release_leaves.py
- cited by
- lemonfiber@d852da61ef
Generating and showing the changelog MUST each be reachable non-interactively.