Add changelog generation tool for GitHub milestones#13063
Open
cmcfarlen wants to merge 3 commits intoapache:masterfrom
Open
Add changelog generation tool for GitHub milestones#13063cmcfarlen wants to merge 3 commits intoapache:masterfrom
cmcfarlen wants to merge 3 commits intoapache:masterfrom
Conversation
Replaces tools/git/changelog.pl with a Python implementation that generates changelogs from merged PRs in a milestone using the GitHub API or gh CLI. Default output matches the existing CHANGELOG-* file format. The --doc mode includes merge SHAs, labels, and full PR descriptions to guide AI-assisted release documentation updates. Supports text and YAML output formats. Co-Authored-By: Claude <noreply@anthropic.com>
Contributor
Author
|
hmm, the uv.lock file is making the RAT check mad. Should I remove uv.lock? |
Replace reference to tools/git/changelog.pl with the new tools/changelog/changelog.py invocation using uv run. Co-Authored-By: Claude <noreply@anthropic.com>
Contributor
I think it's recommended to add uv.lock to ensure the exact packages are added. Let's add it back. The problem wasn't your patch adding the lock, the problem is the RAT check incorrectly failing on the lock file. I'll update CI to allow it. Update |
cmcfarlen
force-pushed
the
new-changelog-tool
branch
from
2b949cf to
44f4931
Compare
Contributor
There was a problem hiding this comment.
Pull request overview
This PR introduces a new Python-based changelog generator under tools/changelog/ to produce CHANGELOG-*-style output from GitHub milestones (via direct REST API calls or the gh CLI), and updates the release-process documentation to use it.
Changes:
- Add
tools/changelog/changelog.pywith text/YAML output and an extended--docmode for richer metadata. - Add
tools/changelog/pyproject.tomlandtools/changelog/uv.lockfor dependency management/execution viauv. - Update release-process docs to use the new tool (with
--use-gh).
Reviewed changes
Copilot reviewed 3 out of 4 changed files in this pull request and generated 7 comments.
| File | Description |
|---|---|
| tools/changelog/changelog.py | Implements milestone PR collection via REST API or gh, plus output formatting. |
| tools/changelog/pyproject.toml | Defines the Python project and console script entry point. |
| tools/changelog/uv.lock | Pins Python dependencies for uv-managed execution. |
| doc/developer-guide/release-process/index.en.rst | Updates the documented release workflow to generate changelogs via the new tool. |
Comment on lines
+70
to
+71
| uv run --project tools/changelog python tools/changelog/changelog.py \ | ||
| -o apache -r trafficserver -m X.Y.Z --use-gh > CHANGELOG-X.Y.Z |
Comment on lines
+70
to
+71
| uv run --project tools/changelog python tools/changelog/changelog.py \ | ||
| -o apache -r trafficserver -m X.Y.Z --use-gh > CHANGELOG-X.Y.Z |
Comment on lines
+242
to
+250
| resp = client.get(f"/repos/{owner}/{repo}/milestones") | ||
| _check_rate_limit(resp) | ||
| resp.raise_for_status() | ||
| for ms in resp.json(): | ||
| if ms["title"] == title: | ||
| return ms["number"] | ||
| return None | ||
|
|
||
|
|
| """Use the gh CLI to fetch milestone PRs (avoids API rate limits).""" | ||
| milestone_id = None | ||
| result = subprocess.run( | ||
| ["gh", "api", f"/repos/{owner}/{repo}/milestones", "--paginate"], |
Comment on lines
+278
to
+282
| parser.add_argument( | ||
| "--doc", | ||
| action="store_true", | ||
| help="Include extra metadata (merge SHA, full commit message, labels) for documentation", | ||
| ) |
Comment on lines
+52
to
+57
|
|
||
| try: | ||
| import yaml | ||
| except ImportError: | ||
| yaml = None | ||
|
|
| sys.exit(2) | ||
|
|
||
|
|
||
| def main(): |
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.
Replaces tools/git/changelog.pl with a Python implementation that generates changelogs from merged PRs in a milestone using the GitHub API or gh CLI. Default output matches the existing CHANGELOG-* file format. The --doc mode includes merge SHAs, labels, and full PR descriptions to guide AI-assisted release documentation updates. Supports text and YAML output formats.