opt-logging VS semver

View on GitHub

Turns out, version comparison is one of those things that looks simple until you actually try to do it properly. Just ask the folks at semver.org - they've been at it for years! My journey through the commit history of this project reads like a tragicomedy of version comparison attempts.

apiVersion: v2 name: chart description: A Helm chart for Kubernetes # A chart can be either an 'application' or a 'library' chart. # # Application charts are a collection of templates that can be packaged into versioned archives # to be deployed. # # Library charts provide useful utilities or functions for the chart developer. They're included as # a dependency of application charts to inject those utilities and functions into the rendering # pipeline. Library charts do not define any templates and therefore cannot be deployed. type: application # This is the chart version. This version number should be incremented each time you make changes # to the chart and its templates, including the app version. # Versions are expected to follow Semantic Versioning (https://semver.org/) version: 0.1.0 # This is the version number of the application being deployed. This version number should be # incremented each time you make changes to the application. Versions are not expected to # follow Semantic Versioning. They should reflect the version the application is using. # It is recommended to use it with quotes. appVersion: "1.16.0"

The version tags follow the semver convention. major.minor.patch

For standardized versioning, many organizations adopt Semantic Versioning, which provides a clear framework for communicating the nature of changes.

Starting with Manticore 7.4.6, we've adopted proper Semantic Versioning (SemVer). This standardized approach uses a three-part version number (MAJOR.MINOR.PATCH) with clear rules:

For humans, yes. For software, not so much.

There’s a special rule in SemVer that states when the leading major version is 0, every minor version bump is considered breaking.

https://semver.org/#spec-item-4

NPM handles 0.x.y versions of packages differently from 1+.x.y

https://github.com/npm/node-semver#caret-ranges-123-025-004

Several major packages are still on 0.x.y and (ab)use this feature when updating without "committing" to a major version.

Semver 2.0.0 Compatibility Tenv utilizes go-version for semantic versioning and HCL parsing to extract version constraints from files like required_version in Terraform/OpenTofu or Terragrunt HCL files.

- Semantic Versioning: Follow semantic versioning principles (MAJOR.MINOR.PATCH) to help consumers understand the impact of updates.

I've seen people use semantic versioning to version APIs and SDKs

https://semver.org/

We at Skyvern are still doing patch versions only

Update version in Chart.yaml according to SemVer principles.