Skip to content

Latest commit

 

History

History
70 lines (56 loc) · 3.07 KB

RELEASING.md

File metadata and controls

70 lines (56 loc) · 3.07 KB

Release Process

Releases are performed in lockstep with open-telemetry/semantic-conventions releases.

Preparing a new release

Applies to major, minor and patch releases of open-telemetry/semantic-conventions.

  • Merge a PR to main with the following changes:
    • Update the CHANGELOG.md
      • The heading for the unreleased entries should be ## Unreleased
    • Bump the semanticConventionsVersion variable in build.gradle.kts to version of semantic-conventions to be released
    • Follow the instructions to generate the semantic conventions
  • Run the Prepare release branch workflow
    • Press the "Run workflow" button, and leave the default branch main selected
    • Review and merge the two pull requests it creates (one is targeted to the release branch and one is targeted to main)

Preparing a patch release

TODO(jack-berg): Define process for releasing a patch, which should add a 4th component to the semantic-convention release version, e.g. v1.21.0.1

Making the release

  • Run the Release workflow
    • Press the "Run workflow" button, then select the release branch from the dropdown list, e.g. release/v1.21.0, and click the "Run workflow" button below that.
    • This workflow will publish artifacts to maven central and will publish a GitHub release with release notes based on the change log.

Making release candidate locally

  • Follow steps to prepare a new release, but DO NOT make the release

  • Check out release branch locally

  • Set required environment variables

    • export CI=true - trick tooling to thinking this is the official release process, and sign artifacts
    • export GPG_PRIVATE_KEY=<private_key>
    • export GPG_PASSWORD=<password>
    • export SONATYPE_USER=<user>
    • export SONATYPE_KEY=<key>

  • Adjust version tag to include -rc.<num> suffix (i.e. -rc.1 for the first release candidate) in build.gradle.kts:

    var ver = semanticConventionsVersion
val release = findProperty("otel.release")
if (release != null) {
  ver += "-" + release
}
if (snapshot) {
  ver += "-SNAPSHOT"
}
ver += "-rc.1" // <-- ADD THIS LINE
version = ver

  • Build and publish artifacts to staging repository

    • Run ./gradlew assemble publishToSonatype closeSonatypeStagingRepository
    • Notably, this stages the artifacts in sonatype and gives a chance for manual verification before publishing
    • Publishing via the sonatype UI

  • After publishing, manually create Github release using the contents from the CHANGELOG.md

Credentials

See opentelemetry-java credentials.