Skip to content

Latest commit

 

History

History
25 lines (14 loc) · 1.46 KB

RELEASING.md

File metadata and controls

25 lines (14 loc) · 1.46 KB
Raw

Creating a new release

  1. Prep Honeycomb docs PR with the new version in data file data/projects/honeycomb-opentelemetry-java/release.json

  2. Run ./gradlew generateLicenseReport to ensure all project dependency licenses are correctly represented in this repository. If there are any changes, submit PR to update licenses.

  3. Update the project.version in the root build.gradle file with the new release version. Snapshot version is one patch bump ahead of the new release (e.g. if we're releasing 1.0.0 then the corresponding snapshot would be 1.0.1)

  4. Update the version in common/src/main/java/io/honeycomb/opentelemetry/DistroMetadata.java with the new release version

    • When updating the OTel Agent/SDK version, update the OTLP version header as needed in DistroMetadata.java
    • This can be found in upstream repo /dependencyManagement/build.gradle.kts

  5. If OTLP proto version changes in previous step, update tests in EnvironmentConfigurationTest.java

  6. Update the Changelog

  7. If the new release updates the OpenTelemetry SDK and/or agent versions, update the Latest release built with section in the README.

  8. Once the above changes are merged into main, tag main with the new version, e.g. v0.1.1. Push the tags. This will kick off CI, which will publish a draft GitHub release, and publish to Maven.

  9. Update Release Notes on the new draft GitHub release, and publish that.

  10. Merge public docs PR and onboard docs PR

Voila!