ci: update release job to automatically generate release notes #3187
+3
−37
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
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #3187 +/- ##
==========================================
- Coverage 87.07% 85.67% -1.40%
==========================================
Files 221 25 -196
Lines 13723 1424 -12299
Branches 739 0 -739
==========================================
- Hits 11949 1220 -10729
+ Misses 1753 204 -1549
+ Partials 21 0 -21
Flags with carried forward coverage won't be shown. Click here to find out more. |
BobanL
requested review from
akasper,
angelathe,
austin-hall-skylight,
gordonfarrell,
JNygaard-Skylight,
lina-roth,
mcmcgrath13 and
robertmitchellv
as code owners
mcmcgrath13
approved these changes
Jan 23, 2025
robertmitchellv
pushed a commit
that referenced
this pull request
Jan 23, 2025
# PULL REQUEST ## Summary - Update release action to auto generate release notes - [Tag will get created if it does not exist](https://cli.github.com/manual/gh_release_create#:~:text=If%20a%20matching%20git%20tag%20does%20not%20yet%20exist%2C%20one%20will%20automatically%20get%20created%20from%20the%20latest%20state%20of%20the%20default%20branch.) - [Title will automatically be created based on the tag](https://cli.github.com/manual/gh_release_create#:~:text=When%20using%20automatically%20generated%20release%20notes%2C%20a%20release%20title%20will%20also%20be%20automatically%20generated%20unless%20a%20title%20was%20explicitly%20passed.%20Additional%20release%20notes%20can%20be%20prepended%20to%20automatically%20generated%20notes%20by%20using%20the%20%2D%2Dnotes%20flag.) ## Related Issue Fixes #3103 ## Acceptance Criteria - [x] Release notes contain the title and description for each merged pull request included in the release - [x] Pull requests that have been closed but not merged are not included in the release notes ## Additional Information Example of what `gh release create 0.0.2 --generate-notes` will create:  ## Checklist - [ ] If this code affects the other scrum team, have they been notified? (In Slack, as reviewers, etc.) [//]: # "PR title: Remember to name your PR descriptively!"
robertmitchellv
pushed a commit
that referenced
this pull request
Jan 24, 2025
# PULL REQUEST ## Summary - Update release action to auto generate release notes - [Tag will get created if it does not exist](https://cli.github.com/manual/gh_release_create#:~:text=If%20a%20matching%20git%20tag%20does%20not%20yet%20exist%2C%20one%20will%20automatically%20get%20created%20from%20the%20latest%20state%20of%20the%20default%20branch.) - [Title will automatically be created based on the tag](https://cli.github.com/manual/gh_release_create#:~:text=When%20using%20automatically%20generated%20release%20notes%2C%20a%20release%20title%20will%20also%20be%20automatically%20generated%20unless%20a%20title%20was%20explicitly%20passed.%20Additional%20release%20notes%20can%20be%20prepended%20to%20automatically%20generated%20notes%20by%20using%20the%20%2D%2Dnotes%20flag.) ## Related Issue Fixes #3103 ## Acceptance Criteria - [x] Release notes contain the title and description for each merged pull request included in the release - [x] Pull requests that have been closed but not merged are not included in the release notes ## Additional Information Example of what `gh release create 0.0.2 --generate-notes` will create:  ## Checklist - [ ] If this code affects the other scrum team, have they been notified? (In Slack, as reviewers, etc.) [//]: # "PR title: Remember to name your PR descriptively!"
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.
PULL REQUEST
Summary
Related Issue
Fixes #3103
Acceptance Criteria
Additional Information
Example of what
gh release create 0.0.2 --generate-noteswill create:Checklist