Skip to content
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 #437

Conversation

qrkourier
Copy link
Contributor

@qrkourier qrkourier commented Jul 24, 2024

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."

@qrkourier qrkourier force-pushed the generate-release-notes-since-latest-chart branch from b2f5ad6 to cefc64d Compare July 25, 2024 20:14
@pull-request-size pull-request-size bot added size/L and removed size/M labels Jul 25, 2024
@qrkourier qrkourier force-pushed the generate-release-notes-since-latest-chart branch from cb00c72 to 50ffaf8 Compare July 25, 2024 21:12
@qrkourier qrkourier force-pushed the generate-release-notes-since-latest-chart branch from 3f96594 to d9a2daa Compare July 25, 2024 23:30
@qrkourier qrkourier marked this pull request as ready for review July 25, 2024 23:31
@qrkourier
Copy link
Contributor Author

superseded #439

@qrkourier qrkourier closed this Jul 30, 2024
@qrkourier qrkourier deleted the generate-release-notes-since-latest-chart branch July 30, 2024 15:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Changelog in release description
1 participant