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

[Enhancement][opensearch] Release notes included in the GitHub Release Page #173

Open
sastorsl opened this issue Dec 13, 2021 · 9 comments
Labels
enhancement New feature or request

Comments

@sastorsl
Copy link
Contributor

sastorsl commented Dec 13, 2021

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

@sastorsl sastorsl added enhancement New feature or request untriaged Issues that have not yet been triaged labels Dec 13, 2021
@peterzhuamazon
Copy link
Member

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.

@peterzhuamazon peterzhuamazon removed the untriaged Issues that have not yet been triaged label Dec 14, 2021
@peterzhuamazon peterzhuamazon changed the title [Enhancement][opensearch] Release notes [Enhancement][opensearch] Release notes included in the GitHub Release Page Dec 14, 2021
@sastorsl
Copy link
Contributor Author

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

@sastorsl
Copy link
Contributor Author

Could for instance commit messages since the last merge be included in the release notes?

@sastorsl
Copy link
Contributor Author

sastorsl commented Jan 7, 2022

@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
Copy link
Member

@DandyDeveloper @smlx thoughts?

@smlx
Copy link
Contributor

smlx commented Jan 10, 2022

See here: helm/chart-releaser#118

@sastorsl
Copy link
Contributor Author

Did the team get a chance to look into this?

@sastorsl
Copy link
Contributor Author

sastorsl commented Apr 8, 2022

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

@TheAlgo
Copy link
Member

TheAlgo commented Apr 8, 2022

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: helm/chart-releaser#118

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
Status: Backlog
Development

No branches or pull requests

4 participants