fix: skip TBD changelog entries in docs generator#273
Merged
c-vigo merged 3 commits intorelease/0.3.0from Mar 12, 2026
Merged
Conversation
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.
Description
Fixes release-branch CI failures where
generate-docsrewroteREADME.mdto an unreleasedTBDversion afterprepare-release.The changelog parser in
docs/generate.pynow selects the latest dated release entry, and regression tests ensureTBDentries are skipped.Type of Change
fix-- Bug fixdocs-- Documentation onlychore-- Maintenance task (deps, config, etc.)refactor-- Code restructuring (no behavior change)test-- Adding or updating testsci-- CI/CD pipeline changesbuild-- Build system or dependency changesrevert-- Reverts a previous commitstyle-- Code style (formatting, whitespace)Modifiers
!) -- This change breaks backward compatibilityChanges Made
docs/generate.pyTBDentries.get_version_from_changelog()andget_release_date_from_changelog()to pick the first heading containing a concreteYYYY-MM-DDdate.tests/test_utils.py## [x.y.z] - TBDheadings are skipped.CHANGELOG.md### Fixedentry in## [0.3.0] - TBDfor issue#271.Changelog Entry
Fixed
get_version_from_changelog()andget_release_date_from_changelog()now skip entries without a concrete release dateTesting
just test)Manual Testing Details
uv run pytest tests/test_utils.py -k "skips_tbd_entry"(RED before fix; two failures reproduced)uv run pytest tests/test_utils.py -k "changelog"(GREEN after fix; passing)uv run pre-commit run generate-docs --all-files(docs regenerated without remaining diffs)Checklist
docs/templates/, then runjust docs)CHANGELOG.mdin the[Unreleased]section (and pasted the entry above)Additional Notes
This branch targets
release/0.3.0to unblock the release pipeline affected by PR #270 checks.Refs: #271