Skip to content

Add changelog generation tool for GitHub milestones #13063

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.

Sign up for GitHub

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

Open
cmcfarlen wants to merge 8 commits into
base: master
Choose a base branch
from
+710 −178
Open

Add changelog generation tool for GitHub milestones #13063

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
723e6c5
Add changelog generation tool for GitHub milestones
cmcfarlen Apr 6, 2026
8290c17
Update release process docs to use new changelog tool
cmcfarlen Apr 6, 2026
2ca3031
remove old changelog.pl script
cmcfarlen Apr 22, 2026
6f625e2
Add git range support to generate changelog from commits without PR o…
cmcfarlen Jul 29, 2026
298c1fd
changelog: surface gh api failures in the merge check
cmcfarlen Sep 3, 2026
6c26293
changelog: point uv.lock at public PyPI, tighten two checks
cmcfarlen Sep 9, 2026
378b586
changelog: require PyYAML, dedupe git entries by PR number
cmcfarlen Sep 9, 2026
c0a28af
changelog: safe_dump, drop the inert entry point, document prerequisites
cmcfarlen Sep 9, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 16 additions & 4 deletions doc/developer-guide/release-process/index.en.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,10 +65,22 @@ Build
#. Check the version in ``CMakeLists.txt``. There is a ``project`` line near the
top with the version number. Make sure that is correct for the release.

#. Generate or update the CHANGELOG for the next release. ::

./tools/git/changelog.pl -o apache -r trafficserver -m X.Y.Z >
CHANGELOG-X.Y.Z
#. Generate or update the CHANGELOG for the next release. This needs
`uv <https://docs.astral.sh/uv/>`__, and ``--use-gh`` additionally needs the
`GitHub CLI <https://cli.github.com/>`__ already authenticated with
``gh auth login``. ::

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 thread
cmcfarlen marked this conversation as resolved.
Comment thread
cmcfarlen marked this conversation as resolved.
Comment thread
cmcfarlen marked this conversation as resolved.

Without the GitHub CLI, omit ``--use-gh`` and supply a token through the
``GH_TOKEN`` environment variable instead. A token is not optional here: an
unauthenticated run exceeds the GitHub API rate limit partway through a
release-sized milestone and exits without writing a changelog. ::

GH_TOKEN=<token> uv run --project tools/changelog \
python tools/changelog/changelog.py \
-o apache -r trafficserver -m X.Y.Z > CHANGELOG-X.Y.Z

#. Commit this file to the repository and push it to the release branch.

Expand Down
Loading