Reorganize releases notes on upgrading and new features #361
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
This commit reorganizes the release notes to move all "breaking changes" to the Upgrading section, and to group changes by type (removal, rename, renumbering and addition) and by protobuf package. This hopefully will make easier for users to know how to deal with changes and what new fetures are available, depending on which packages they use/they are interested in. Signed-off-by: Leandro Lucarella <[email protected]>
Signed-off-by: Leandro Lucarella <[email protected]>
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR restructures the release notes by moving breaking changes into a clear Upgrading section, grouping changes by type and protobuf package, and adds a note about the bumped protobuf/grpcio dependency.
- Reorganized Upgrading into Removed, Renamed, Renumbered, and Dependency bump subsections
- Refactored New Features into package-scoped groupings
- Added missing note on
protobuf/grpciominimum version bump
Comments suppressed due to low confidence (2)
RELEASE_NOTES.md:34
- The New Features section refers to this field as
info.grid_connection_point, but here it'skind.grid_connection_point. Please standardize on one identifier to avoid confusion.
`ComponentCategoryMetadataVariant.metadata.grid` to `ElectricalComponentCategorySpecificInfo.kind.grid_connection_point`
RELEASE_NOTES.md:83
- [nitpick] The
typesentry currently has no description. For consistency, consider adding a colon and brief description, e.g.,- types: Package with common API types (e.g., TimeIntervalFilter).
- `types`
tiyash-basu-frequenz
approved these changes
Jun 5, 2025
Contributor
Author
|
Whoops, should I have mentioned more explicitly that auto-merge was enabled? 😬 |
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.
Reorganize the release notes to move all "breaking changes" to the Upgrading section, and to group changes by type (removal, rename, renumbering and addition) and by protobuf package.
This hopefully will make easier for users to know how to deal with changes and what new fetures are available, depending on which packages they use/they are interested in.
Also add missing note about
protobuf/grpciodependency bump.