helm-charts
helm-charts copied to clipboard
opensearch-project
[Enhancement][opensearch] Release notes included in the GitHub Release Page
Is your feature request related to a problem? Please describe. Release notes include the name of the component and version number, but no release information. This means you have to go hunting for what was released / changed / breaking.
Example https://github.com/opensearch-project/helm-charts/releases/tag/opensearch-1.5.4
Describe the solution you'd like Automatically include release notes for all releases, both opensearch, opensearch-dashboards and future charts.
Example: https://docs.github.com/en/repositories/releasing-projects-on-github/automatically-generated-release-notes
Describe alternatives you've considered N/A
Additional context There are a few examples out there, i.e. https://github.com/helm/chart-releaser/releases
Hi @sastorsl so you mean we should include the release notes in the release page, not just in the CHANGELOG.md file? If so, do you have any solutions that can contribute as a PR? Thanks.
I don't have a solution ready on hand no, but I guess there are at least some examples around. I.e. the latest release from Prometheus https://github.com/prometheus/prometheus/releases/tag/v2.32.0
Could for instance commit messages since the last merge be included in the release notes?
@peterzhuamazon would more examples help? I'm not personally familiar with how to achieve this, but there are examples in upstream and other project of the outcome, both on what is included in the releases page on github, but also what is included in the RSS feeds.
It is really helpful when following the RSS-feeds since we are constantly reviewing tens / hundres of packages.
@peterzhuamazon as a minimum, could the Release Note point to the merged PR?
Ref https://github.com/opensearch-project/helm-charts/releases/tag/opensearch-dashboards-1.4.0 It would help if one could click directly on the link to the PR.
PR link is something we can get from the commit in the release but the release note can be a bit more verbose. There are many interesting examples in the link which @smlx shared
See here: https://github.com/helm/chart-releaser/issues/118
