Skip to content

RELEASE.md

Latest commit

 

History

History
37 lines (24 loc) · 1.27 KB

RELEASE.md

File metadata and controls

37 lines (24 loc) · 1.27 KB

Guide for publication

  1. Create a pull request named Release vx.y.z (add the Github tag release).

  2. Describe the new features and the bug fixes in the CHANGELOG.md file.

  3. Upgrade the x.y.z version in libversion.gradle if necessary (it may have been bumped already for SNAPSHOT versioning):

ext.libversion="x.y.z"

  1. Submit your pull request.

  2. Once the branch is merged into master, create a new tag.

    git tag <tag_name>

    Push it on origin.

    git push origin <tag_name>

    circleci will automatically trigger a build, run the tests and publish the new version of the SDK on MavenCentral.

    It's important to push the tag separately otherwise the deployment job is not triggered (https://support.circleci.com/hc/en-us/articles/115013854347-Jobs-builds-not-triggered-when-pushing-tag).

    Refer to the .circleci/config.yml file to set up the integration.

  3. Finally, create a new release in the Github releases tab (copy & paste the changelog in the release's description).