opentelemetry-dotnet-instrumentation/docs/releasing.md

Release Process

1. Update the version in the following files:

   • download.sh
   • docs/README.md
   • src/OpenTelemetry.AutoInstrumentation.Loader/OpenTelemetry.AutoInstrumentation.Loader.csproj
   • src/OpenTelemetry.AutoInstrumentation.Native/CMakeLists.txt
   • src/OpenTelemetry.AutoInstrumentation.Native/Resource.rc
   • src/OpenTelemetry.AutoInstrumentation.Native/otel_profiler_constants.h
   • src/OpenTelemetry.AutoInstrumentation.Native/version.h
   • src/OpenTelemetry.AutoInstrumentation/OpenTelemetry.AutoInstrumentation.csproj
   • 'src/OpenTelemetry.AutoInstrumentation\Constants.cs'

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

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

4. Run the integration tests with Linux containers on Windows and macOS (not covered by CI):

   nuke Workflow --containers linux
   

5. Test the described examples.

6. 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 {remote-to-the-main-repo} $TAG
   

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

7. Publish a release in GitHub:

   • Use the CHANGELOG.md content in the description.
   • Add the artifacts from the release GitHub workflow.

8. Update version in install-script job in .github/workflows/ci.yml.

9. Update version under OpenTelemetry Operator.