chore: include tonic updates in release notes #559
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
In the past we have marked commits which update tonic as `chore`, which excludes them from the release notes. However, when we update tonic to a new (pre-1.0) major version, such as from 0.10 to 0.11, this is a breaking change for both the `console-api` and the `console-subscriber` crates. As such, it shouldn't be skipped. This change adds a new commit type `update`, to use for updating dependencies. It will have it's own section in the release notes. A commit preprocessing rule has been added to the Git-Cliff config file to change commit subjects from `chore: bump tonic` to `update: bump tonic` so that they're caught in the new category (this will fix it for the next release which includes upgrading tonic from 0.10 to 0.11). The contributor guide has also been updated to mention this new commit type.
hi-rustin
approved these changes
Jun 7, 2024
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.
In the past we have marked commits which update tonic as
chore, whichexcludes them from the release notes. However, when we update tonic to a
new (pre-1.0) major version, such as from 0.10 to 0.11, this is a
breaking change for both the
console-apiand theconsole-subscribercrates. As such, it shouldn't be skipped.
This change adds a new commit type
update, to use for updatingdependencies. It will have it's own section in the release notes. A
commit preprocessing rule has been added to the Git-Cliff config file to
change commit subjects from
chore: bump tonictoupdate: bump tonicso that they're caught in the new category (this will fix it for the
next release which includes upgrading tonic from 0.10 to 0.11).
The contributor guide has also been updated to mention this new commit
type.