New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
chore: add script to generate release notes #10806
chore: add script to generate release notes #10806
Conversation
Signed-off-by: Michael Crenshaw <350466+crenshaw-dev@users.noreply.github.com>
Codecov ReportBase: 45.67% // Head: 45.67% // Decreases project coverage by
Additional details and impacted files@@ Coverage Diff @@
## master #10806 +/- ##
==========================================
- Coverage 45.67% 45.67% -0.01%
==========================================
Files 236 236
Lines 28697 28697
==========================================
- Hits 13108 13106 -2
- Misses 13798 13799 +1
- Partials 1791 1792 +1
Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. ☔ View full report at Codecov. |
Signed-off-by: Michael Crenshaw <350466+crenshaw-dev@users.noreply.github.com>
Signed-off-by: Michael Crenshaw <350466+crenshaw-dev@users.noreply.github.com>
Signed-off-by: Michael Crenshaw <350466+crenshaw-dev@users.noreply.github.com>
Signed-off-by: Michael Crenshaw <350466+crenshaw-dev@users.noreply.github.com>
@@ -274,7 +274,8 @@ jobs: | |||
tag_name: ${{ env.RELEASE_TAG }} | |||
draft: ${{ env.DRAFT_RELEASE }} | |||
prerelease: ${{ env.PRE_RELEASE }} | |||
body: ${{ steps.release-notes.outputs.content }} | |||
generate_release_notes: true |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Docs for this boolean: https://github.com/softprops/action-gh-release#-customizing
Whether to automatically generate the name and body for this release. If name is specified, the specified name will be used; otherwise, a name will be automatically generated. If body is specified, the body will be pre-pended to the automatically generated notes. See the GitHub docs for this feature for more information
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
* chore: add script to generate release notes Signed-off-by: Michael Crenshaw <350466+crenshaw-dev@users.noreply.github.com> * newlines look bad in the release markdown rendering on GitHub Signed-off-by: Michael Crenshaw <350466+crenshaw-dev@users.noreply.github.com> * use diff instead of comp Signed-off-by: Michael Crenshaw <350466+crenshaw-dev@users.noreply.github.com> * use auto-generated docs Signed-off-by: Michael Crenshaw <350466+crenshaw-dev@users.noreply.github.com> * pre-pended, not appended Signed-off-by: Michael Crenshaw <350466+crenshaw-dev@users.noreply.github.com> Signed-off-by: Michael Crenshaw <350466+crenshaw-dev@users.noreply.github.com>
* chore: add script to generate release notes Signed-off-by: Michael Crenshaw <350466+crenshaw-dev@users.noreply.github.com> * newlines look bad in the release markdown rendering on GitHub Signed-off-by: Michael Crenshaw <350466+crenshaw-dev@users.noreply.github.com> * use diff instead of comp Signed-off-by: Michael Crenshaw <350466+crenshaw-dev@users.noreply.github.com> * use auto-generated docs Signed-off-by: Michael Crenshaw <350466+crenshaw-dev@users.noreply.github.com> * pre-pended, not appended Signed-off-by: Michael Crenshaw <350466+crenshaw-dev@users.noreply.github.com> Signed-off-by: Michael Crenshaw <350466+crenshaw-dev@users.noreply.github.com>
Cherry-picked onto release-2.4 for 2.4.15. Want to see what GitHub will generate if I provide an empty release notes body. |
This script generates some stats to add to the release notes.
It also uses GitHub's auto-generated release notes for the details. Rollouts uses it: https://github.com/argoproj/argo-rollouts/releases/tag/v1.3.1