Write smarter changelog tool in Rust#7801
Merged
Manishearth merged 2 commits intounicode-org:mainfrom Mar 24, 2026
Merged
Conversation
44424be to
61ddfb9
Compare
sffc
approved these changes
Mar 23, 2026
Member
sffc
left a comment
There was a problem hiding this comment.
Looks reasonable, without having reviewed with a great level of detail.
61ddfb9 to
e36778e
Compare
Member
Author
|
Oops, pushed before noticing the review. |
f49f275 to
cb49221
Compare
sffc
approved these changes
Mar 24, 2026
Member
sffc
left a comment
There was a problem hiding this comment.
Things in tools/ don't need a super detailed review. It seems fine. I agree with using gh to reduce Rust dependencies.
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.
Our changelog process still calls for manual collation, but there's the boring part (collating by crate and reformatting) and the interesting part (actually prioritizing items in the changelog).
I made the script do most of the boring work.
It produces a report that looks like this: https://hackmd.io/XKCDISO_RhmAH7Ib1zqhjw. The first section of the report contains changelog entries organized by crate. After that the report includes information on additional "notes" found in some PRs that were not a part of the changelog entries but should be considered in the final collation, as well as a list of PRs without changelog information and PRs marked N/A for spot-checking.
A neat thing is that this separates the github fetching from the changelog generation: so you can fetch github state once to JSON (you can even update state for individual PRs in the json), and then run the tool repeatedly.
It currently uses the
ghtool because I didn't want to set up a proper login flow.This is a run-every-few-months tool, so I would prefer to land this as is, with improvements happening over time, without extensive code style/structure review. The maintenance burden of such a tool is low, and if it stops working, it stops working; it is not critical to anything.
Changelog: N/A
Internal