Auto-bump version number in generated release notes #2140
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
We are using Release Drafter[^1] to automatically write our release notes. Before, Release Drafter was configured to increment the version number at the patch level, regardless of what was included in the release notes. For example, if the current version is 3.17.3, the draft of the next release would assume a version number of 3.17.4. With this commit, Release Drafter will now bump the version number based on the concents of the release. A patch bump is the default, but if there is a new feature or breaking change in the release, it will now recommend a minor bump. This commit also modifies the release notes template to add a link to the full diff of the release on GitHub. [^1]: https://github.com/release-drafter/release-drafter
mattbrictson
commented
Sep 22, 2023
| name-template: "$NEXT_PATCH_VERSION" | ||
| tag-template: "v$NEXT_PATCH_VERSION" | ||
| name-template: "$RESOLVED_VERSION" | ||
| tag-template: "v$RESOLVED_VERSION" |
There was a problem hiding this comment.
🗒️ This tells Release Drafter to intelligently pick the next version number, rather than always doing a patch bump.
Comment on lines
+14
to
+19
| version-resolver: | ||
| minor: | ||
| labels: | ||
| - "⚠️ Breaking" | ||
| - "✨ Feature" | ||
| default: patch |
There was a problem hiding this comment.
🗒️ Simple logic for determining $RESOLVED_VERSION
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.
We are using Release Drafter1 to automatically write our release notes.
Before, Release Drafter was configured to increment the version number at the patch level, regardless of what was included in the release notes. For example, if the current version is 3.17.3, the draft of the next release would assume a version number of 3.17.4.
With this commit, Release Drafter will now bump the version number based on the concents of the release. A patch bump is the default, but if there is a new feature or breaking change in the release, it will now recommend a minor bump.
This commit also modifies the release notes template to add a link to the full diff of the release on GitHub.
Footnotes
https://github.com/release-drafter/release-drafter ↩