Skip to content

Latest commit

 

History

History
28 lines (23 loc) · 2.29 KB

RELEASE.md

File metadata and controls

28 lines (23 loc) · 2.29 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, with N-2 being the lower bound. Make sure that the CI is currently testing the latest Kubernetes version!
  5. Add the changes to the changelog
  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. After the release, generate a new OLM bundle (make bundle) and create two PRs against the Community Operators repositories:
    1. one for the community-operators-prod, used by OLM on Kubernetes. Example: operator-framework/community-operators-prod
    2. one for the community-operators directory, used by Operatorhub.io. Example: operator-framework/community-operators

Generating the changelog

Run this generator:

docker run --rm  -v "${PWD}:/app" pavolloffay/gch:latest --oauth-token ${GH_WRITE_TOKEN} --owner open-telemetry --repo opentelemetry-operator --branch main
  • Note that you must generate a Personal Access Token (PAT) and set GH_WRITE_TOKEN as that.

Remove the commits that are not relevant to users, like:

  • CI or testing-specific commits (e2e, unit test, ...)
  • bug fixes for problems that are not part of a release yet
  • version bumps for internal dependencies