RELEASING.md

Release Process

Versioning is using MinVer. No changes in the code are needed to correctly version this package.

1. Update the CHANGELOG.md with the new release.

2. Create a pull request on GitHub with the changes described in the changelog.

   • *scripts* and validate-documentation jobs will fail because the release is not published yet.

3. Once the pull request has been merged, create a signed tag for the merged commit. You can do this using the following Bash snippet:

   TAG='v{new-version-here}'
   COMMIT='{commit-sha-here}'
   git tag -s -m $TAG $TAG $COMMIT
   git push upstream $TAG

   After you've pushed the git tag, a ci GitHub workflow starts.

4. Publish a release in GitHub:

   • Use a draft created by create-release GitHub job in ci workflow.
   • Use the CHANGELOG.md content in the description.
   • Ensure that following flags under the are correctly set
     • Set as a pre-release
     • Set as the latest release

5. Publish the NuGet packages:

   1. Download Splunk.OpenTelemetry.AutoInstrumentation.*.nupkg to a local directory.
   2. Upload and publish the package to nuget.org.

6. Check that the operator-docker image has been published.

7. Ask o11y-docs team

   1. to execute update metadata workflow to update matrix in o11y-gdi-metadata repository,
   2. to publish necessary updates to the documentation.

8. Update version in microservices-demo.

9. Update version in tracing-examples:

   1. automatic
   2. log example

10. Update internal repository. Follow internal documentation.