-
Notifications
You must be signed in to change notification settings - Fork 114
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
generate release notes for delta since latest release of each chart #439
base: main
Are you sure you want to change the base?
Conversation
This Chart Releaser change creates release notes like these with GitHub's built-in notes generator: https://github.com/openziti/helm-charts/releases/tag/ziti-controller-1.0.13 As before this change, the GitHub's notes generator is configured by GitHub's notes generator keys on PR labels like Chart Releaser is executed by chart-releaser-action, a shell action I modified to accept the existing |
Signed-off-by: Kenneth Bingham <[email protected]>
generate release notes for delta since latest release of each chart
CLEANUP toYaml
handle no prior releases
Change the way
--generate-release-notes
works.If
--release-notes-file
exists, then--generate-release-notes
is ignored. It was previously appended after the release notes file's contents in the release description.Else if
--generate-release-notes
, then use the GitHub API to generate notes for the delta between the latest release of the chart and the current commit which will be the next release.Else, as before, use the chart metadata description as the release description.
resolves helm/chart-releaser-action#44
The proposed change allows
cr
to focus release notes on the relevant pull requests since the latest release of the same chart. Combined with a.github/release.yml
, the generated notes can be further narrowed to ensure they only include pull requests for the specific chart. This requires labeling PRs which can be done automatically based on changed files in a pull request or manually.I'll provide an functioning example using these elements before marking this PR as "ready for review."