This document explains the release strategy for artifacts in this organization.
The tags are based on major.x branches. Hence each PR needs to be backported to respective major.x branch in order to included in next release. The Github workflow backport.yml creates backport PRs automatically when the original PR with an appropriate label backport is merged to main with the backport workflow run successfully on the PR. For example, if a PR on main needs to be backported to 1.x branch, add a label backport 1.x to the PR and make sure the backport workflow runs on the PR along with other checks. Once this PR is merged to main, the workflow will create a backport PR against 1.x branch.
This respository, as other in this organization follows semantic versioning.
- major: Breaking changes
- minor: New features
- patch: Bug fixes
The release process includes a maintainer voluntering for the release. They need to follow the below steps:
- Changing the version number in build.gradle.
- This triggers the version increment workflow and creates a version increment PR across the 1.x branch. Example
- Once merged, the maintainer needs to push a tag based on 1.x which creates a release on GitHub via release.yml workflow.