open-telemetry / opentelemetry-helm-charts

OpenTelemetry Helm Charts
https://opentelemetry.io
Apache License 2.0
393 stars 479 forks source link

Align Major and Minor Versions Between version and appVersion in Chart.yaml files #1378

Open jvoravong opened 1 week ago

jvoravong commented 1 week ago

Description:

In the current Chart.yaml setup, the version (chart version) and appVersion (version of the app deployed by the chart) have major and minor versions that are not always in sync. This inconsistency makes it difficult to track the chart version and the appVersion that were deployed together. From my experience, this is unusual. I would like to request the version and appVersion major and minor version partss always match, allowing for easier version tracking and debugging.

I propose that we ensure the major and minor versions of both version and appVersion in Chart.yaml are always kept in sync, while allowing the patch version to increment independently for any differences between them.

This would:

Operator Chart.yaml Example:

TylerHelmuth commented 1 week ago

This is an interesting idea, but we currently don't do this by design. It allows us to release the chart independently from the thing it deploys and follow its own semvar standard. Sometimes there are breaking changes or features in the chart that are based on Kubernetes and not the thing being installed.

Keeping the major and minor in lock step with the app version is also not a pattern I've seen in other charts. The Prometheus charts, which we like to follow when we can, does not do this suggestion for example. Have you seen other charts do this?