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 #439

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

qrkourier
Copy link
Contributor

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
Copy link
Contributor Author

qrkourier commented Jul 30, 2024

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 --release-notes-file is used if it exists instead of GitHub's notes generator.

GitHub's notes generator is configured by .github/release.yml like this: https://github.com/openziti/helm-charts/blob/ziti-controller-1.0.13/.github/release.yml

GitHub's notes generator keys on PR labels like notes:ziti-router that are automatically added based on changed files by this labeler action: https://github.com/openziti/helm-charts/blob/ziti-controller-1.0.13/.github/workflows/release-notes.yml#L19

Chart Releaser is executed by chart-releaser-action, a shell action I modified to accept the existing cr --generate-release-notes: https://github.com/openziti/helm-charts/blob/ziti-controller-1.0.13/.github/workflows/release-charts.yml#L44 uses https://github.com/netfoundry/chart-releaser-action/blob/v0.0.3/action.yml#L59

generate release notes for delta since latest release of each chart
@qrkourier qrkourier reopened this Sep 26, 2024
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
2 participants