Skip to content

Latest commit

 

History

History
33 lines (30 loc) · 1.41 KB

RELEASING.md

File metadata and controls

33 lines (30 loc) · 1.41 KB

Update Version

  1. Update VERSION_CODE in gradle.properties
  2. Update VERSION_NAME in gradle.properties
  3. Update LIBRARY_VERSION in core/Constants.kt

Releasing

  1. Create a new branch called release/X.Y.Z
  2. git checkout -b release/X.Y.Z
  3. Change the version in gradle.properties to your desired release version (see Update Version)
  4. git commit -am "Create release X.Y.Z." (where X.Y.Z is the new version)
  5. git tag -a X.Y.Z -m "Version X.Y.Z" (where X.Y.Z is the new version)
  6. Upgrade to next version by changing version in gradle.properties
  7. git commit -am "Prepare snapshot X.Y.Z-SNAPSHOT"
  8. git push && git push --tags
  9. Create a PR to merge the new branch into master
  10. The CI pipeline will recognize the tag and upload, close and promote the artifacts automatically, and generate changelog automatically

Example (stable release)

  1. Current VERSION_NAME in gradle.properties = 1.3.0
  2. git checkout -b release/1.3.1
  3. Change VERSION_NAME = 1.3.1 (next higher version)
  4. Update CHANGELOG.md
  5. git commit -am "Create release 1.3.1
  6. git tag -a 1.3.1 -m "Version 1.3.1"
  7. git push && git push --tags
  8. Change VERSION_NAME = 1.3.2 (next higher version)
  9. git commit -am "Prepare snapshot 1.3.2-SNAPSHOT"
  10. git push && git push --tags
  11. Merging PR master will create a snapshot release 1.3.2-SNAPSHOT and tag push will create stable release 1.3.1