Conversation
sbesson
approved these changes
Dec 4, 2025
Member
sbesson
left a comment
There was a problem hiding this comment.
This is consistent with the strategy I have been applying across several repositories including OMERO.py but also Java components like ome-common
Auto-generating the release notes for individual components is fairly low-maintenance and generally produces a good outcome. I also find this approach to be complementary of writing more curated release notes e.g. for Bio-Formats and OMERO as the latter tend to be more user-facing.
Two things to keep in mind while pivoting towards this strategy:
- there is no single entry point that aggregates the changelog of all changes across versions. The closest equivalent would be the releases endpoint e.g.https://github.com/ome/omero-scripts/releases but this might involve some scrolling & navigation if looking at the change across several releases
- the auto-generation of the release body further increases the importance of good titles (& bodies) for the individual contributions e.g. avoiding generic titles like
Fix bug. This puts additional responsibility on maintainers but also confers them with further authority during the review process to ensure these are correctly filled.
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.
Create a release automatically when a new tag is pushed