generate release notes for delta since latest release of each chart #437
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.
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."