-
Notifications
You must be signed in to change notification settings - Fork 154
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
Suggestions for chart versioning and release management #344
Comments
Thanks for sharing your observations, @illrill It seems like there are several points made here at once:
So more on "release notes for Helm charts" problem. In general, I'm definitely inclined towards re-using the same approach that other Grafana charts utilize, whenever possible. But, not all Grafana charts have the same approach in the first place. E.g. both That said, if anyone sees a simple and straight-forward way to add release notes to Helm releases in k6-operator (i.e. similar to what loki-distributed has), please feel free to make a PR 🙂 If not, we'll improve on this, but no promises on when exactly. On a kind of related note, I would hardly call current Helm chart release "stable" (just today's incident), still 😞 |
Ah yes, I see now the I didn't necessarily mean that we should publish the chart or its changes to artifacthub.io, it was just a real-life example of how the Argo project has chosen to handle chart release notes and versioning in general, using the approach I suggested with a |
Actually, yes, definitely! Thank you for the pointer 🙂 |
For record's sake. |
Have you considered to version/release the application and the chart together, instead of them having separate life cycles and release notes? The application release notes in this repository are superb! |
Right, I see two main problems with it ATM: updates for application don't always map 1-1 to Helm updates. Right now it's possible to release a fix to Helm without touching application release and vice versa. So there's a flexibility in the current setup which we might want to preserve for the future. None of this is set in stone yet. I'll be pondering this more and likely discussing it internally as well; but it'd be good to improve release process for sure. |
Feature Description
Release notes
Would like some type of chart release notes. Bare minimum populate
What's Changed
in the Github release, in the same way as thegrafana
andloki-distributed
charts do it by just referencing PRs.In addition to referencing PRs under
What's Changed
, there could be a custom release note annotation in Chart.yaml. When a contributor creates a new version, they also overwrite the "old" release notes with the release notes applicable for this version. This could get picked up by the helm chart releaser workflow and included in the Github release. Something like this:Versioning
Maybe it's on its way in #330, but some guidance and enforcement of chart versioning would be good. Again, perhaps we could use argo-helm's guidelines as inspiration.
The text was updated successfully, but these errors were encountered: