Stop the root changelog claiming the release maintains it - #115
Merged
Conversation
`CHANGELOG.md` opened by saying the `Unreleased` section of `docs/changelog.md` is what "release automation promotes into a numbered section here at release time", citing §FS-rhei-distribution.5. That section says the promotion happens inside `docs/changelog.md`, with the displaced release archived under `docs/changelog/`. Nothing has ever written to this file, and `prepare_changelog_release.py` does not open it. So the file documented a behaviour that never ran, and drifted exactly as far as that implies: no `0.2.0`, `0.3.0` or `0.3.1` section, and an `Unreleased` note still announcing project-qualified ticket ids as a forthcoming breaking change eight days after they shipped in 0.2.0. It ships inside the published crate, so it is the first changelog a reader meets. The header now says where the changelog is and that this file is not maintained by the release. The stale `Unreleased` note is gone. The `0.1.0` section stays. `docs/changelog/0.1.0.md` is a four-line summary, so this is the only place the initial release's feature list and its crates.io naming limitation are written down; deleting it to make the file uniform would lose them.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
CHANGELOG.mdopened by saying theUnreleasedsection ofdocs/changelog.mdis what "release automation promotes into a numbered section here at release time", citing §FS-rhei-distribution.5.That section says the promotion happens inside
docs/changelog.md, archiving the displaced release underdocs/changelog/. It says nothing about this file, andprepare_changelog_release.pynever opens it — its--changelogdefault isdocs/changelog.md.So the file documented a behaviour that has never run, and drifted exactly as far as that implies:
0.2.0,0.3.0or0.3.1section — it stops at0.1.0Unreleasednote still announcing project-qualified ticket ids as a forthcoming breaking change, eight days after they shipped in 0.2.0That note is what nearly sent me to a minor bump while cutting 0.3.1; the pending entries were patch-appropriate all along. And
CHANGELOG.mdships inside the published crate, so it is the first changelog a reader meets.The change
The header now says where the changelog actually is and that this file is not maintained by the release. The stale
Unreleasednote is deleted.The
0.1.0section stays, which is the one judgment call here. My first draft replaced the whole file with a pointer; checking before deleting showeddocs/changelog/0.1.0.mdis a four-line summary, soCHANGELOG.mdis the only place the initial release's feature list and its crates.io naming limitation are recorded. Making the file uniform would have quietly lost them.Verification
grund checkoutput byte-identical tomain. No new links introduced —docs/changelog/is written as inline code, not a directory link, since the repo has no precedent for one and lychee gates links in CI.Noted, not fixed here:
release-plan.md:226still says to create the GitHub release "from theCHANGELOG.mdentry", which the release workflow has not done for some time — it extracts the inline section fromdocs/changelog.md. That file is explicitly the 0.1.0-era plan, so it wants its own pass.🤖 Generated with Claude Code
https://claude.ai/code/session_01ANPWuKoibZ6NS84tJxeDC8