Sync CHANGELOG.md with github release notes #402
Merged
Conversation
This file contains 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
Created by pulling all the release notes from Github as below, then
manually checking for missing info in CHANGELOG.md.
for TAG in $(git tag -l); do
curl -L "https://api.github.com/repos/bitflags/bitflags/releases/tags/$TAG" \
| jq -r '.body' \
> release-notes/$TAG;
done
KodrAus
approved these changes
Mar 20, 2024
There was a problem hiding this comment.
Thanks @dextero! I should probably adjust my release workflow here a bit. I usually pull the diff straight into the CHANGELOG when assembling a release PR, and then come up with any more descriptive announcement when publishing the actual release. Going forwards I'll try write the full content of the release into the CHANGELOG and then populate the GitHub release from that.
|
The build failure here is unrelated; I'll fix that up separately. |
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.
I was updating another crate to use bitflags v2 by using the changelog file as a sort of migration guide. Only when I was done going through the list of PRs I learned that the github release notes contained information than would have been useful 馃槄
So I pulled all the release notes as described on https://stackoverflow.com/a/76996206, and copied over any significant information I found missing to the CHANGELOG.md.
This might be helpful to anyone else like me who doesn't immediately think about looking at release notes.