Skip to content

Add more tweaks to RELEASE.md #64

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

Merged
anuraaga merged 1 commit into from
Dec 9, 2025
Merged

Add more tweaks to RELEASE.md #64

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 2 additions & 2 deletions RELEASE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Note the new version X.Y.Z in the updated files.

_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.
Copy link
Collaborator Author

@anuraaga anuraaga Dec 8, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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


5. Using the Github UI, create a new release.

Expand All @@ -26,7 +26,7 @@ Note the new version X.Y.Z in the updated files.
- Click “set as latest release”.
- 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!
Copy link
Collaborator Author

@anuraaga anuraaga Dec 8, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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


6. Publish the release.

Expand Down