github/kata-containers
1
0
Fork 1
mirror of https://github.com/kata-containers/kata-containers.git synced 2025-08-11 12:52:23 +00:00
Code Issues Projects Releases Wiki Activity

docs: Maintain only one stable branch per major release

Browse Source 
This is a proposal that was sent to the ML and can be accessed via
http://lists.katacontainers.io/pipermail/kata-dev/2021-May/001894.html

Shortly, the proposal is to maintain only one stable branch per major
active release.

This will help the developers and the CI maintainers, to spend more time
on what's coming, rather on backporting and debugging issues with old
releases; while still providing one stable branch that downstream
companies can rely on.

Hopefully, with this we'll be able to lower the maintainance burden and
spend more time on getting things rock solid / move forward in a faster
pace with the project.

Fixes: #1876

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

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

@ -49,9 +49,10 @@ No new features should be introduced to stable branches. This is intended to li
providing only bug and security fixes. providing only bug and security fixes.
## Branch Management ## Branch Management
Kata Containers will maintain two stable release branches in addition to the main branch. Kata Containers will maintain **one** stable release branch, in addition to the main branch, for
each active major release.
Once a new MAJOR or MINOR release is created from main, a new stable branch is created for Once a new MAJOR or MINOR release is created from main, a new stable branch is created for
the prior MAJOR or MINOR release and the older stable branch is no longer maintained. End of the prior MAJOR or MINOR release and the previous stable branch is no longer maintained. End of
maintenance for a branch is announced on the Kata Containers mailing list. Users can determine maintenance for a branch is announced on the Kata Containers mailing list. Users can determine
the version currently installed by running `kata-runtime kata-env`. It is recommended to use the the version currently installed by running `kata-runtime kata-env`. It is recommended to use the
latest stable branch available. latest stable branch available.
@ -68,13 +69,13 @@ stable branch.
|--|--|--| |--|--|--|
| `main` | `1.3.0-rc0` | `1.3.0-rc1` | | `main` | `1.3.0-rc0` | `1.3.0-rc1` |
| `stable-1.2` | `1.2.0` | `1.2.1` | | `stable-1.2` | `1.2.0` | `1.2.1` |
| `stable-1.1` | `1.1.2` | `1.1.3` | | `stable-1.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 older stable branch (stable-1.1) branch is created (stable-1.3) starting from main and the previous stable branch (stable-1.2)
is dropped from maintenance. is dropped from maintenance.
@ -82,10 +83,10 @@ is dropped from maintenance.
|--|--|--| |--|--|--|
| `main` | `1.3.0-rc1` | `1.3.0` | | `main` | `1.3.0-rc1` | `1.3.0` |
| `stable-1.3` | N/A| `1.3.0` | | `stable-1.3` | N/A| `1.3.0` |
| `stable-1.2` | `1.2.1` | `1.2.2` | | `stable-1.2` | `1.2.1` | (unmaintained) |
| `stable-1.1` | `1.1.3` | (unmaintained) | | `stable-1.1` | (unmaintained) | (unmaintained) |
Note, the stable-1.1 branch will still exist with tag 1.1.3, but under current plans it is Note, the stable-1.2 branch will still exist with tag 1.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 1.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 1.4.0), followed by a release candidate. The release candidate marks a feature freeze.