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.
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."
qrkourier
commented
3 months ago
Change the way
--generate-release-notesworks.If
--release-notes-fileexists, then--generate-release-notesis 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 https://github.com/helm/chart-releaser-action/issues/44
The proposed change allows
crto 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."