Changelog

[nikolaik]

Awesome work and great to see all the improvements to the repo!

I would love to see formatted changelogs for releases, like a list of merged PRs, to quickly spot any potential breaking changes. Especially since they can happen pretty frequent in the 0.x.x time of development

[ChrisJBurns]

Hi @nikolaik I wonder whether it is worth it? The way the repository has been set up is that on every PR merge to main, the release flow is triggered. So there is only ever one PR (theoretically) that goes out with every release, instead of a release being made up of multiple PR's.

I agree, it would be beneficial to link the PR itself to the release notes, however, it may have to be a manual effort that's needed as to automate this would be a bit of an effort - for very little pay off.

[nikolaik]

Hi @ChrisJBurns totally agree that using too much effort on this is not worth it. If helm/chart-releaser#229 or similar functionality is merged to helm's chart-releaser, could using automatic changelogs from GitHub be an option?

[ChrisJBurns]

Something like that would be great (does depend on the ease of use though)! It will mean that one more thing is added to every PR, but I think it's not the end of the world, especially as it allows for users to see what's changed in the releases page. So either way, time is being saved for someone

[ChrisJBurns]

@nikolaik @tumido Could we possibly add something that describes what a contributor has to do to get the release notes to be generated? Whether it's in the PR template or a contribution docs, what do you think?

[tumido]

I'm sorry, I'm not sure I fully understand. As far as I know, the change introduced in #50 is tapping into the GitHub's (now) native automatic release note generator. So all that user has to do, is to provide a PR title. And that is not really a change, this was always needed. Or did I miss something?

[nikolaik]

I believe that is what is supposed to happen aswell. chart-releaser uses this GitHub API to create a release with the generate_release_notes option set, which should populate the release with a body according to these docs

[ChrisJBurns]

Ahh, was my misunderstanding then :) I mistakenly assumed there'd be a release for the merge of PR but then just realised that nothing technically got released in the time this PR got merged. Ignore me :)