Docs follow the release process for Kabanero as a whole - Kabanero uses semver versioning.
Here is an example flow of the Kabanero release using 0.2.0
as the next release example:
Assumption: When a new release of Kabanero as a whole is ready the next version number will always be a Major or Minor increment (never a Patch increment).
- When
0.2.0
release date comes maintainers cut the0.2.0
release on the repo and that's the end of the release process.
- If after a release, a piece of documentation needs to have a small update or a quick bug fix (and should be deployed before the next scheduled release,
0.3.0
, in this example) maintainers would: - create a
release-0.2
branch based off the0.2.0
release. - Put the changes in the
release-0.2
branch andmaster
branch, if applicable (see Note below). - Cut a new release based off the
release-0.2
branch and increment the patch number so it becomes0.2.1
- Publish release
0.2.1
.
The patch version of the docs
repo is independent of the patch version of Kabanero; the major and minor version numbers of the docs and Kabanero are in sync. For example, a docs
release of 0.2.1
corresponds to Kabanero version 0.2.x
and vice versa.
Note: In this hot fix example the master
branch will always be going towards the next release so new commits to master
will always be 0.3.0
related.