Skip to content

Latest commit

 

History

History
73 lines (45 loc) · 3.1 KB

RELEASING.md

File metadata and controls

73 lines (45 loc) · 3.1 KB
Raw

Releasing Splunk OpenTelemetry Python

This document explains the steps required to publish a new release of splunk-opentelemetry Python package to PYPI.

We'll pretend to release version 1.1.0

Release process:

  1. Checkout a release branch
  2. Submit PR for review and merge to main
  3. Release the package
  4. Create and push tag
  5. Create github release
  6. Verify release
  7. Publish the draft GitHub Release

1. Prepare the release branch

Run the following command to prepare the release branch assuming we want to release version 1.1.0

make prepare-release VERSION=1.1.0

This will create a new branch release/v1.1.0, bump the package version to 1.1.0, update the changelog file and update all documentation references to point to the new version.

2. Submit changes for review

Push the new branch release/v1.1.0 to Github and create a PR. The PR title should be Release v<VERSION_NUMBER> and the description should be all the changes, additions and deletions this versions will ship. This can be copied as is from the CHANGELOG file. Merge the PR back to main once it is approved.

3. Release the new package

Switch to main branch and pull the latest changes. Make sure your git head is on the release commit. Switch to the commit if it is not.

Go to the gitlab UI. First, refresh the gitlab mirror of this repo manually to be sure you will tag the latest changes. From the gitlab UI (and not from github or through your github cli), create a new tag for the release with the v prefix. For example, if you're releasing 1.1.0:

v1.1.0

Again, be sure that you are tagging in gitlab, not github. The gitlab tag will trigger a pipeline there.

4. Monitor Gitlab release job

Go to the Gitlab Splunk Otel Python releaser and verify the build for your new version was successful.

This CI job will automatically create a Github release with changelogs and artifacts, and also publish new version to PyPI.

5. Crete github release

Go to the github UI and manually create a github release with the changelog contents and the built package. Name it according to the version number for this release.

6. Verify release

  • Go to the Gitlab Splunk Otel Python releaser project and verify the new GH release was created and all artifacts were uploaded.

  • Go to (https://pypi.org/project/splunk-opentelemetry/)[https://pypi.org/project/splunk-opentelemetry/] and verify the new package was published. It may take a few minutes for the web interface to reflect the new package but it should be installable instantly.

  • Download checksums.txt from the GH release and ensure they match the checksums from pypi.org for each artifact.

7. Test new release

Navigate to examples/falcon, upgrade splunk-opentelemetry package to the new version and verify it is working as expected. If you're feeling like doing some more work, commit the changes to the example falcon app and submit a PR.