Repository navigation
docs(changelog): record what 0.41.0 and 0.42.0 actually contain - #345
Conversation
#340 and #341 merged while the 0.41.0 release PR waited for review, so they shipped in v0.41.0 but its notes, generated at prepare time, never listed them, and 0.42.0 came out empty. Write the notes under 0.41.0 and say 0.42.0 carries no change. validate-changelog now allows adding to a released section while still refusing to drop a bullet.
| missing = [ | ||
| line | ||
| for line in body.splitlines() | ||
| if line.startswith("- ") and line not in cur_sections[ver].splitlines() |
There was a problem hiding this comment.
nit: Extend the docstring at lines 2-5 to describe the additive rule, and state that only - bullets are guarded (not blocking).
The docstring still says each section must "match exactly". The code now allows additions. The code also permits edits and deletions of prose lines and headings, such as the new 0.42.0 sentence. A bullet that moves under a different ### heading also passes. A reader of the docstring expects stricter protection than the script gives.
| print(f" {line}", file=sys.stderr) | ||
| failed = True | ||
| else: | ||
| print(f"changelog: section [{ver}] amended additively") |
There was a problem hiding this comment.
super nit: Change the final summary at line 90 from "preserved unchanged" to "preserved". After an additive amendment, the run prints "amended additively" and then "preserved unchanged", and those two messages contradict each other (not blocking).
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
Why
The 0.41.0 release PR waited on review long enough for #340 (
create --if-not-exists) and #341 (load --database, ambiguity message, globalquery -d) to merge ahead of it. They shipped inside the v0.41.0 tag but outside its notes, which git-cliff had generated at prepare time, and the next run started at the tag, so 0.42.0 shipped with an empty section. #343 prevents a recurrence; this PR corrects the record.What
CHANGELOG.md: 0.41.0 lists chore(deps): bump hotdata SDK to 0.20.0 #338, feat(databases): add --if-not-exists to create #340 and fix(databases): load by id, scope query status, name fork ambiguity #341 under Features, Bug Fixes and Other; 0.42.0 states it carries no change since 0.41.0 and why.scripts/validate-changelog.py: a released section may now be added to, but still fails if any existing bullet is dropped, which is the git-cliff regeneration hazard it guards against. Verified locally againstorigin/main.The GitHub Releases for v0.41.0 and v0.42.0 are updated to the same text.