Repository navigation
docs(changelog): record what 0.41.0 and 0.42.0 actually contain #345
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -61,12 +61,28 @@ def main() -> None: | |
| ) | ||
| failed = True | ||
| elif cur_sections[ver] != body: | ||
| print( | ||
| f"CHANGELOG.md: section [{ver}] differs from {base} " | ||
| "(released sections must not be rewritten)", | ||
| file=sys.stderr, | ||
| ) | ||
| failed = True | ||
| # A released section may gain notes (a correction after the fact, | ||
| # as when the 0.41.0 notes missed two PRs that merged while its | ||
| # release PR waited for review) but never lose any: every bullet | ||
| # the base carries must still be there verbatim. That keeps the | ||
| # guard against git-cliff regenerations dropping history while | ||
| # letting an additive fix through. | ||
| missing = [ | ||
| line | ||
| for line in body.splitlines() | ||
| if line.startswith("- ") and line not in cur_sections[ver].splitlines() | ||
| ] | ||
| if missing: | ||
| print( | ||
| f"CHANGELOG.md: section [{ver}] drops bullets present on {base} " | ||
| "(released notes may be added to, never rewritten):", | ||
| file=sys.stderr, | ||
| ) | ||
| for line in missing: | ||
| print(f" {line}", file=sys.stderr) | ||
| failed = True | ||
| else: | ||
| print(f"changelog: section [{ver}] amended additively") | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 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). |
||
|
|
||
| if failed: | ||
| sys.exit(1) | ||
|
|
||
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.