Add more tweaks to RELEASE.md #64
Merged
Conversation
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
Signed-off-by: Anuraag Agrawal <anuraaga@gmail.com>
anuraaga
commented
Dec 8, 2025
| _Make sure no new commits are merged until the release is complete._ | ||
|
|
||
| 4. Review all commits in the new release and for each PR check an appropriate label is used and edit the title to be meaningful to end users. This will help auto-generated release notes match the final notes as closely as possible. | ||
| 4. Review all commits in the new release and for each PR check an appropriate label is used and edit the title to be meaningful to end users. |
Collaborator
Author
There was a problem hiding this comment.
I thought I may not know about a new feature in GitHub but when trying, I didn't get any auto-categorization by label, so I removed the point about it. It does make the motivation to confirm labels on PRs low though I did keep that point
| - Set the last version as the “Previous tag”. | ||
| - Click “Generate release notes” to autogenerate release notes. | ||
| - Edit the release notes. A summary and other sub categories may be added if required but should, in most cases, be left as ### Enhancements and ### Bugfixes. Feel free to collect multiple small changes to docs or Github config into one line, but try to tag every contributor. Make especially sure to credit new external contributors! | ||
| - Edit the release notes. A summary and other categories should be added, in most cases, with the two categories ### Enhancements and ### Bugfixes. Feel free to collect multiple small changes to docs or Github config into one line, but try to tag every contributor. Make especially sure to credit new external contributors! |
Collaborator
Author
There was a problem hiding this comment.
Reworded to reflect that there isn't anything to "be left as". I ended up upgrading summary from "may" to "should" to avoid making it too convoluted, and I think having even a one line summary can often be nice and it's still not a requirement
stefanvanburen
approved these changes
Dec 8, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
No description provided.