Skip to content

Commit d3daa95

Browse files
committed
docs: document branching strategy
1 parent 4f90210 commit d3daa95

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

docs/book/src/developers/releasing.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,23 @@ Example versions:
6363
- Patch release: `v0.1.1`
6464
- Major release: `v1.0.0`
6565

66+
The major and minor versions mirror the version of Cluster-API. Thus CAPG 1.11.x releases will use CAPI versions 1.11
67+
68+
The patch version is incremented for each release. Thus the first release of CAPG using CAPI 1.11 will 1.11.0, the second will be 1.11.1, etc
69+
70+
## Branches
71+
72+
We maintain release branches to facilitate backporting fixes. These branches are named `release-<major>.<minor>`. Patch releases are tagged from the corresponding release branch.
73+
74+
Feature development happens on the `main` branch, and [nightlies](nightlies.md) are released from the `main` branch also.
75+
While we aim to keep the `main` branch healthy, it is intended for development and testing, and should not be used in production.
76+
77+
As such, we will aim to keep the main branch up to date with the latest versions of all dependencies (go toolchain, CAPI, other go module dependencies).
78+
79+
Release branches lock to a particular minor version of CAPI, but will update other dependencies on these branches while they are supported.
80+
Currently we maintain only one release branch (and the `main` branch). Once a branch is no longer supported there will be no new releases
81+
of the corresponding minor, including no further security fixes.
82+
6683
## Expected artifacts
6784

6885
1. A release yaml file `infrastructure-components.yaml` containing the resources needed to deploy to Kubernetes

0 commit comments

Comments
 (0)