Tip for generating release notes with GH handles #2398
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
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #2398 +/- ##
=======================================
Coverage 98.30% 98.30%
=======================================
Files 87 87
Lines 4003 4003
=======================================
Hits 3935 3935
Misses 68 68 ☔ View full report in Codecov by Sentry. |
jordandsullivan
approved these changes
Jun 3, 2024
natestemen
reviewed
Jun 3, 2024
| Alternatively, the list of released changes can be generated via [GitHub CLI](https://cli.github.com/) with the following commands: | ||
|
|
||
| LATEST_TAG=$(gh release list --repo unitaryfund/mitiq --limit 1 --json tagName --jq '.[0].tagName') | ||
| gh api repos/unitaryfund/mitiq/compare/$LATEST_TAG...main --paginate --jq '.commits | reverse | .[] | (.commit.message | split("\n")[0]) + " [@" + .author.login + "]"' |
There was a problem hiding this comment.
Checking my understanding here: --paginate is required to ensure we don't just get the first "page" of commits in the case where there are a large number of commits in the release. Is that right?
There was a problem hiding this comment.
I copied that --paginate option from an example in the gh api docs, and my interpretation of it was the same as yours.
cosenal
added a commit
that referenced
this pull request
Jun 26, 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.
Documenting a tip for generating release notes that include Github handles out of the box, thus removing a tedious step for the release manager.