github/kata-containers
1
0
Fork 1
mirror of https://github.com/kata-containers/kata-containers.git synced 2025-06-27 07:48:55 +00:00
Code Issues Projects Releases Wiki Activity

docs: Use stable-2.x / 2.x.y as example in the branch strategy document

Browse Source 
This may help to reduce some confusion as 1.x was a totally different
thing for the project.

Signed-off-by: Fabiano Fidêncio <fidencio@redhat.com>
This commit is contained in:
Fabiano Fidêncio 2021-05-18 15:20:32 +02:00
parent a5e1f66a15
commit a0af2bd7dc
1 changed files with 15 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
docs/Stable-Branch-Strategy.md
View File

@ -67,31 +67,31 @@ stable branch.
| Branch | Original version | New version | | Branch | Original version | New version |
|--|--|--| |--|--|--|
| `main` | `1.3.0-rc0` | `1.3.0-rc1` | | `main` | `2.3.0-rc0` | `2.3.0-rc1` |
| `stable-1.2` | `1.2.0` | `1.2.1` | | `stable-2.2` | `2.2.0` | `2.2.1` |
| `stable-1.1` | (unmaintained) | (unmaintained) | | `stable-2.1` | (unmaintained) | (unmaintained) |
### New release made feature or change adding new inter-component dependency ### New release made feature or change adding new inter-component dependency
A new feature is introduced, which adds a new inter-component dependency. In this case a new stable A new feature is introduced, which adds a new inter-component dependency. In this case a new stable
branch is created (stable-1.3) starting from main and the previous stable branch (stable-1.2) branch is created (stable-2.3) starting from main and the previous stable branch (stable-2.2)
is dropped from maintenance. is dropped from maintenance.
| Branch | Original version | New version | | Branch | Original version | New version |
|--|--|--| |--|--|--|
| `main` | `1.3.0-rc1` | `1.3.0` | | `main` | `2.3.0-rc1` | `2.3.0` |
| `stable-1.3` | N/A| `1.3.0` | | `stable-2.3` | N/A| `2.3.0` |
| `stable-1.2` | `1.2.1` | (unmaintained) | | `stable-2.2` | `2.2.1` | (unmaintained) |
| `stable-1.1` | (unmaintained) | (unmaintained) | | `stable-2.1` | (unmaintained) | (unmaintained) |
Note, the stable-1.2 branch will still exist with tag 1.2.1, but under current plans it is Note, the stable-2.2 branch will still exist with tag 2.2.1, but under current plans it is
not maintained further. The next tag applied to main will be 1.4.0-alpha0. We would then not maintained further. The next tag applied to main will be 2.4.0-alpha0. We would then
create a couple of alpha releases gathering features targeted for that particular release (in create a couple of alpha releases gathering features targeted for that particular release (in
this case 1.4.0), followed by a release candidate. The release candidate marks a feature freeze. this case 2.4.0), followed by a release candidate. The release candidate marks a feature freeze.
A new stable branch is created for the release candidate. Only bug fixes and any security issues A new stable branch is created for the release candidate. Only bug fixes and any security issues
are added to the branch going forward until release 1.4.0 is made. are added to the branch going forward until release 2.4.0 is made.
## Backporting Process ## Backporting Process
@ -145,8 +145,8 @@ Kata guarantees compatibility between components that are within one minor relea
This is critical for dependencies which cross between host (runtime, shim, proxy) and This is critical for dependencies which cross between host (runtime, shim, proxy) and
the guest (hypervisor, rootfs and agent). For example, consider a cluster with a long-running the guest (hypervisor, rootfs and agent). For example, consider a cluster with a long-running
deployment, workload-never-dies, all on Kata version 1.1.3 components. If the operator updates deployment, workload-never-dies, all on Kata version 2.1.3 components. If the operator updates
the Kata components to the next new minor release (i.e. 1.2.0), we need to guarantee that the 1.2.0 the Kata components to the next new minor release (i.e. 2.2.0), we need to guarantee that the 2.2.0
runtime still communicates with 1.1.3 agent within workload-never-dies. runtime still communicates with 2.1.3 agent within workload-never-dies.
Handling live-update is out of the scope of this document. See this [`kata-runtime` issue](https://github.com/kata-containers/runtime/issues/492) for details. Handling live-update is out of the scope of this document. See this [`kata-runtime` issue](https://github.com/kata-containers/runtime/issues/492) for details.