-
Notifications
You must be signed in to change notification settings - Fork 239
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
[Enhancement][opensearch] Release notes included in the GitHub Release Page #173
Comments
Hi @sastorsl so you mean we should include the release notes in the release page, not just in the CHANGELOG.md file? |
I don't have a solution ready on hand no, but I guess there are at least some examples around. |
Could for instance commit messages since the last merge be included in the release notes? |
@peterzhuamazon would more examples help? It is really helpful when following the RSS-feeds since we are constantly reviewing tens / hundres of packages. |
@DandyDeveloper @smlx thoughts? |
See here: helm/chart-releaser#118 |
Did the team get a chance to look into this? |
@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 |
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
|
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
The text was updated successfully, but these errors were encountered: