-
Notifications
You must be signed in to change notification settings - Fork 0
ci: validate CHANGELOG sections match base branch on PRs #72
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
+87
−0
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 |
|---|---|---|
| @@ -0,0 +1,73 @@ | ||
| #!/usr/bin/env python3 | ||
| """Fail if CHANGELOG.md alters any release section that already exists on the base ref. | ||
|
|
||
| git-cliff full regenerations can drop bullets from older versions; this catches that | ||
| by requiring each ## [version] block from the base to match exactly in the working tree. | ||
| """ | ||
|
|
||
| from __future__ import annotations | ||
|
|
||
| import re | ||
| import subprocess | ||
| import sys | ||
| from pathlib import Path | ||
|
|
||
| SECTION_START = re.compile(r"^## \[([^\]]+)\]", re.MULTILINE) | ||
|
|
||
|
|
||
| def split_sections(text: str) -> dict[str, str]: | ||
| matches = list(SECTION_START.finditer(text)) | ||
| sections: dict[str, str] = {} | ||
| for i, m in enumerate(matches): | ||
| version = m.group(1) | ||
| start = m.start() | ||
| end = matches[i + 1].start() if i + 1 < len(matches) else len(text) | ||
| sections[version] = text[start:end].rstrip() + "\n" | ||
| return sections | ||
|
|
||
|
|
||
| def git_show_changelog(ref: str) -> str: | ||
| return subprocess.check_output( | ||
| ["git", "show", f"{ref}:CHANGELOG.md"], | ||
| text=True, | ||
| ) | ||
|
|
||
|
|
||
| def main() -> None: | ||
| base = sys.argv[1] if len(sys.argv) > 1 else "origin/main" | ||
| current = Path("CHANGELOG.md").read_text() | ||
|
|
||
| try: | ||
| base_text = git_show_changelog(base) | ||
| except subprocess.CalledProcessError as e: | ||
| print(f"error: could not read {base}:CHANGELOG.md ({e})", file=sys.stderr) | ||
|
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: |
||
| sys.exit(1) | ||
|
|
||
| base_sections = split_sections(base_text) | ||
| cur_sections = split_sections(current) | ||
|
|
||
| failed = False | ||
| for ver, body in base_sections.items(): | ||
| if ver not in cur_sections: | ||
| print( | ||
| f"CHANGELOG.md: missing section [{ver}] that exists on {base}", | ||
| file=sys.stderr, | ||
| ) | ||
| 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 | ||
|
|
||
| if failed: | ||
| sys.exit(1) | ||
| print( | ||
| f"changelog ok: {len(base_sections)} section(s) from {base} preserved unchanged", | ||
| ) | ||
|
|
||
|
|
||
| if __name__ == "__main__": | ||
| main() | ||
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:
read_text()is called outside thetry/except, so a missing working-treeCHANGELOG.mdproduces a rawFileNotFoundErrortraceback instead of a clean error. Wrapping it gives a friendlier failure:(not blocking)