-
Notifications
You must be signed in to change notification settings - Fork 1.8k
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
[Repo] Can the releases provide a changelog? #1721
Comments
Hi @syphernl, Thank you for reporting! IMO, I think we can introduce GitHub's official feature in order to reduce tool dependencies. 🤔 WDYT? @mkilchhofer @jmeridth |
Ah, that seems to be easier/more practical to implement when there is native support for that. It appears somebody figured out how to add release notes to
Unfortunately Renovate doesn't seem to support ArtifactHub changelogs. If it is not feasible / desirable to implement release notes on the argo-helm GitHub releases as well, would it be possible to include a link to the changelog instead? Something like: A Helm chart for Argo CD, a declarative, GitOps continuous delivery tool for Kubernetes.
[View changelog of argo-cd 5.16.9](https://artifacthub.io/packages/helm/argo/argo-cd?modal=changelog&version=5.16.9) While not as practical as having a list of changes visible directly, this should make it a little easier. |
I've implemented something like this for my own chart repository: https://github.com/chgl/charts. The initial PR is https://github.com/chgl/charts/pull/149/files. This takes the artifacthub annotations and turns them into a markdown changelog using gotemplate + yq. I've since moved the scripts and templates to https://github.com/chgl/kube-powertools/blob/master/scripts/generate-chart-changelog.sh and https://github.com/chgl/kube-powertools/blob/master/opt/CHART-CHANGELOG.md.gotmpl respecitvely. Here's an exmaple It uses chart-releaser's Here's a sample release: https://github.com/chgl/charts/releases/tag/ohdsi-0.20.1 with the corresponding chart annotations here: https://github.com/chgl/charts/blob/ohdsi-0.20.1/charts/ohdsi/Chart.yaml#L40 |
This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions. |
Not stale. This is still relevant. |
@chgl feature works fine! I use it on my charts repository. The use of Artifact Hub annotations is also a very good idea |
This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions. |
Still relevant. |
It would be very helpful if this gets implemented because the changelogs provided by tools like Renovate are empty. |
Is your feature request related to a problem?
We use Renovate to update dependencies. Every time the argo-cd helm chart gets an update (which is pretty frequently) all the changelog shows is:
This information is obtained from the releases, such as this one for argo-cd-5.16.9.
This requires us to manually check all changes between the releases, which is time-consuming and one of the reasons we use Renovate to consolidate this information into one place.
Related helm chart
argo-cd, argo-events, argo-rollouts, argo-workflows, argocd-image-updater, argocd-apps
Describe the solution you'd like
Perhaps something like semantic-release can be used to parse the commits and let it generate a changelog to associate with the release.
Describe alternatives you've considered
No response
Additional context
No response
The text was updated successfully, but these errors were encountered: