Repository navigation
Conversation
The published page still showed "1.6.0 (unreleased)": the page was a hand-written copy written once with the docs and never updated, and the docs workflow only redeploys for pushes that touch docs/, which a release commit does not. The page now includes the root changelog from a marker comment, `conf.py` reads the version from `Cargo.toml` (it said 1.5 since February), and the workflow also triggers on `CHANGES.md` and `Cargo.toml`. A test keeps the page from becoming a copy again and checks that a released changelog header matches the version in `Cargo.toml`. Sphinx builds clean with `-W` and the page carries all eleven versions. Assisted-by: Claude Opus 5
This branch has not been deployed
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
1 participant
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.
Fixes #63
The published changelog page showed "1.6.0 (unreleased)" as its newest entry, missing three releases, for two independent reasons.
It was a copy.
docs/sources/reference/changelog.mdduplicated the rootCHANGES.mdby hand, written once in 530cfef and never touched again (97 lines against 332). The page now includes the real file from a marker comment, so there is one changelog.The site was not rebuilt for a release.
docs.ymlonly triggers on pushes touchingdocs/**, and a release commit changesCHANGES.md,Cargo.tomlandCargo.lock. The last docs run was 2026-09-30 15:45, which matches the live page'slast-modifiedexactly. Both files are now in the paths filter.While in there:
conf.pyhard-codedrelease = "1.5", so the site has advertised the wrong version since February. It now readsCargo.toml.Guard
tests/test_changelog_page.pyfails if the page stops including the root file, grows entries of its own, or if the top changelog heading is a version other than the one inCargo.toml(an "unreleased" heading is fine, that is the normal state between releases).Verified
sphinx-build -W --keep-goingis clean, and the built page lists all eleven versions with 1.7.0 first; the toctree link and the reference index card are unchanged.Assisted-by: Claude Opus 5