Skip to content
This repository has been archived by the owner on Jul 1, 2023. It is now read-only.

Latest commit

 

History

History
46 lines (33 loc) · 3.27 KB

RELEASE.md

File metadata and controls

46 lines (33 loc) · 3.27 KB
Raw

Release instructions

Steps to release a new version of the OpenTelemetry Operator:

  1. Change the versions.txt, so that it lists the target version of the OpenTelemetry Collector (operand), and the desired version for the target allocator and the operator. The major.minor should typically match, with the patch portion being possibly different.
  2. Change the autoinstrumentation-* versions in versions.txt as per the latest supported versions in auto-instrumentation/.
  3. Run make bundle USER=open-telemetry VERSION=0.38.0, using the version that will be released.
  4. Change the compatibility matrix in the readme file, using the OpenTelemetry Operator version to be released and the current latest Kubernetes version as the latest supported version.
  5. Add the changes to the changelog. Manually add versions of all operator components.
  6. Check the OpenTelemetry Collector's changelog and ensure migration steps are present in pkg/collector/upgrade
  7. Once the changes above are merged and available in main, tag it with the desired version, prefixed with v: v0.38.0
  8. The GitHub Workflow will take it from here, creating a GitHub release with the generated artifacts (manifests) and publishing the images
  9. The GitHub Workflow, submits two pull requests to the Operator hub repositories. Make sure the pull requests are approved and merged.
    1. community-operators-prod is used by OLM on OpenShift. Example: operator-framework/community-operators-prod
    2. community-operators is used by Operatorhub.io. Example: operator-framework/community-operators
  10. Update release schedule table, by moving the current release manager to the end of the table with updated release version.

Generating the changelog

We now use the chloggen to generate the changelog, simply run the following to generate the Changelog:

make chlog-update

This will delete all entries (other than the template) in the .chloggen directory and create a populated Changelog.md entry. Make sure that the PR you are generating for the release has the [chore] prefix, otherwise CI will not pass.

Release managers

A release manager is the person responsible for a specific release. While the manager might request help from other folks, they are ultimately responsible for the success of a release.

In order to have more people comfortable with the release process, and in order to decrease the burden on a small number of volunteers, all approvers and maintainers are release managers from time to time, listed under the Release Schedule section. That table is updated at every release, with the current manager adding themselves to the bottom of the table, removing themselves from the top of the table.

Release schedule

The operator should be released within a week after the OpenTelemetry collector release.

Version Release manager
v0.77.0 @yuriolisa
v0.78.0 @jaronoff97
v0.79.0 @pavolloffay
v0.80.0 @VineethReddy02
v0.81.0 @TylerHelmuth
v0.82.0 @frzifus