Skip to content
This repository has been archived by the owner on Jul 1, 2022. It is now read-only.

Latest commit

 

History

History
68 lines (56 loc) · 3.96 KB

RELEASE.md

File metadata and controls

68 lines (56 loc) · 3.96 KB
Raw

Release Process

Automatic release (preferred)

The release process consists of these steps:

  1. Create a pull request with:
    • Add an entry to CHANGELOG with changes since the last release
      • Tip: git log --pretty=format:'- %s -- %an'
    • add a new section to the CHANGELOG with that version as (unreleased) and a bullet point - Nothing yet
  2. Commit your CHANGELOG changes as git commit -sm "Preparing release 0.20.0"
  3. Create and push tag with the new version git tag release-0.20.0 && git push origin release-0.20.0. Do not update the version in gradle.properties manually.
  4. The build for the release- tag does following:
    • It updates the version in gradle.properties and creates commit and tag v0.20.0
    • It updates version to the next SNAPSHOT and commits it
    • The next build for the tag publishes artifact to Nexus. If the build fails it might be necessary to drop staging repositories and restart the build or just close the repository.
  5. Create a release on GitHub for the new tag v0.20.0. Use the changes from the CHANGELOG as the description.

Maintenance branches should follow naming convention: release-major.minor (e.g.release-0.20).

Local setup and release

The Travis build execute the uploadArchives task, and this task performs the signing of the artifacts. While the Travis build is ready for that, releasing locally requires the following steps:

  • install GPG: brew install gpg
  • generate keys: gpg --gen-key
  • see installed keys with gpg --list-keys or gpg --list-secret-keys
  • create an account with Sonatype, get repo permissions (e.g. https://issues.sonatype.org/browse/OSSRH-23572)
  • export the secret key ring file with gpg --export -o $HOME/.gnupg/secring.gpg or gpg --export-secret-keys -o $HOME/.gnupg/secring.gpg
  • create $HOME/.gradle/gradle.properties file or add parameters directly as it is shown at the last step.
    signing.keyId={8 hex digit key ID from: gpg --list-secret-keys --keyid-format short}
    signing.password={password you used to encrypt keys via: gpg --gen-key}
    signing.secretKeyRingFile={e.g. $HOME/.gnupg/secring.gpg}

    ossrhUsername={your user name at Sonatype}
    ossrhPassword={your password at Sonatype}
  • upload your public key to Ubuntu servers, e.g.
    • gpg --keyserver http://keyserver.ubuntu.com:11371 --send-keys {pub key ID}
    • you can also use Web UI and upload plain test key that you can obtain via
      • gpg --armor --export {your email used for the keys}
  • Publish the release to Nexus.
    • ./gradlew publish
  • Note that if this fails with error Execution failed for task ':closeRepository'., it might be necessary to close and release via Nexus UI: Closing Staging Repository Manually

Closing Staging Repository Manually

  • https://oss.sonatype.org/, log in, go to Staging Repositories
  • In the top-right corner search box type uber, and find your uploaded repository
  • Hit Close button. Monitor status on Activity tab at the bottom, hitting Refresh.
  • Once Close is successful, the Release button will become available, so hit it
  • Keep hitting Refresh while sync to Maven is in progress. Once it's complete, the repository will disappear.

If manually closing the Staging Repository fails, try cleaning up the existing open Staging Repositories as advised in this gradle-nexus-staging-plugin github discussion thread.

  • https://oss.sonatype.org/, log in, go to Staging Repositories. You should see a list of jaeger staging deployments with Status "open".
  • Select all staging deployments.
  • Hit "Drop" button. Monitor the delete status by hitting Refresh until all Staging Repositories are deleted.
  • Try running ./gradlew publish again.