Skip to content

Latest commit

 

History

History
92 lines (64 loc) · 3.57 KB

RELEASING.md

File metadata and controls

92 lines (64 loc) · 3.57 KB
Raw

Releasing OpenTelemetry Packages (for maintainers only)

This document explains how to publish all OT modules at version x.y.z. Ensure that you’re following semver when choosing a version number.

Release Process:

Checkout a clean repo

  • To avoid pushing untracked changes, check out the repo in a new dir

Create a new branch

The following script does the following:

  • update main locally
  • creates a new release branch release/<version>
  • updates version and changelog files
  • commits the change to a new branch release/<version>-auto

NOTE: This script was run by a GitHub Action but required the Action bot to be excluded from the CLA check, which it currently is not.

./scripts/prepare_release.sh 0.7b0

Open a Pull Request

The PR should be opened from the release/<version>-auto branch created as part of running prepare_release.sh in the steps above.

Create a Release

  • Create the GH release from the release branch, using a new tag for this micro version, e.g. v0.7.0
  • Copy the changelogs from all packages that changed into the release notes (and reformat to remove hard line wraps)

Check PyPI

This should be handled automatically on release by the publish action.

If for some reason the action failed, see Publish failed below

Move stable tag

This will ensure the docs are pointing at the stable release.

git tag -d stable
git tag stable
git push origin stable

To validate this worked, ensure the stable build has run successfully: https://readthedocs.org/projects/opentelemetry-python/builds/. If the build has not run automatically, it can be manually trigger via the readthedocs interface.

Update main

Ensure the version and changelog updates have been applied to main.

# checkout a new branch from main
git checkout -b v0.7b0-main-update
# cherry pick the change from the release branch
git cherry-pick $(git log -n 1 origin/release/0.7b0 --format="%H")
# update the version number, make it a "dev" greater than release number, e.g. 0.8.dev0
perl -i -p -e 's/0.7b0/0.8.dev0/' $(git grep -l "0.7b0" | grep -vi CHANGELOG)
# open a PR targeting main see #331
git commit -m

Update docs

If the docs for the Opentelemetry website was updated in this release in this folder, submit a PR to update the docs on the website accordingly.

Troubleshooting

Publish failed

If for some reason the action failed, do it manually:

  • Switch to the release branch (important so we don't publish packages with "dev" versions)
  • Build distributions with ./scripts/build.sh
  • Delete distributions we don't want to push (e.g. testutil)
  • Push to PyPI as twine upload --skip-existing --verbose dist/*
  • Double check PyPI!