Releases #

This page describes the release process for Thanos project.

NOTE: As Semantic Versioning states all 0.y.z releases can contain breaking changes in API (flags, grpc API, any backward compatibility)

Cadence #

We aim for at least 1 release per 6 weeks. However, no strict dates are planned.

No release candidates are required until major version.

Additionally we aim for master branch being stable.

Cutting individual release #

Process of cutting a new minor Thanos release:

  1. Add PR on branch release-<major>.<minor> that will start minor release branch and prepare changes to cut release.

  2. Bump VERSION file

  3. Update CHANGELOG file Note that CHANGELOG.md should only document changes relevant to users of Prometheus, including external API changes, performance improvements, and new features. Do not document changes of internal interfaces, code refactorings and clean-ups, changes to the build process, etc. People interested in these are asked to refer to the git history. Format is described in CHANGELOG.md.

  4. Double check backward compatibility:

  5. In case of version after v1+.y.z, double check if none of the changes break API compatibility. This should be done in PR review process, but double check is good to have.

  6. In case of v0.y.z, document all incompatibilities in changelog.

  7. After review, merge the PR and immediately after this create a <ver> release on GitHub release page. Describe release and post relevant entry from changelog. Click Save Draft. This will trigger CircleCI that builds artifacts. Once tarballs are published on release page, you can click Publish and release is complete. Announce #thanos slack channel.

Branch management and versioning strategy #

We use Semantic Versioning.

NOTE: We have a separate branch for each minor release, named release-<major>.<minor>, e.g. release-0.1, release-0.2. but they are NOT maintained as we don’t have major version yet.

Pre-releases (release candidates) #

The following changes to the above procedures apply:

  • In line with Semantic Versioning, append something like -rc.0 to the version (with the corresponding changes to the tag name, the release name etc.).
  • Tick the This is a pre-release box when drafting the release in the Github UI.
  • Still update CHANGELOG.md, but when you cut the final release later, merge all the changes from the pre-releases into the one final update.

Found a typo, inconsistency or missing information in our docs? Help us to improve Thanos documentation by proposing a fix on GitHub here ❤️