Skip to content

Commit 69cdc92

Browse files
author
OpenVMM Team
committed
guide: update documentation on release branches
1 parent 1ee447c commit 69cdc92

File tree

1 file changed

+22
-19
lines changed

1 file changed

+22
-19
lines changed

Guide/src/dev_guide/contrib/release.md

Lines changed: 22 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,16 @@
11
# Release Management
22

33
Occasionally, the OpenVMM project will declare upcoming release milestones. We
4-
stabilize the code base in a `release/YYMM` branch, typically named for the
5-
YYMM when the branch was forked. We expect a high quality bar for all code that
6-
goes in to the OpenVMM main branch, we ask developers to hold these
7-
`release/YYMM` to the highest quality standards. The OpenVMM maintainers will
8-
gradually slow the rate of churn into these branches as we get closer to a
9-
close date.
4+
stabilize the code base in a `release/<MAJOR>.<MINOR>.<YYMM>` branch, typically
5+
named for the YYMM when the branch was forked. Future references to the release
6+
number will be shortened to `<RELEASE>` in this doc. We expect a high quality
7+
bar for all code that goes into the OpenVMM main branch, and we ask developers
8+
to hold these release branches to the highest quality standards. The OpenVMM
9+
maintainers will gradually slow the rate of churn into these branches as we get
10+
closer to a close date.
11+
12+
> **Note:** Some older release branches use the format `release/<YYMM>` without
13+
> the major and minor version numbers (e.g., `release/2411`, `release/2505`).
1014
1115
This process should not impact your typical workflow; all new work should go
1216
into the `main` branch. But, to ease the cherry-picks, we may ask that you hold
@@ -26,35 +30,33 @@ Releases naturally fall into several phases:
2630
|-------------------|-------------------------------------------------------------------------|
2731
| Active Development| Regular development phase where new features and fixes are added. |
2832
| Stabilization | Phase focused on stabilizing the release by fixing bugs. |
29-
| Ask Mode | Changes are scrutinized and only critical fixes are allowed. No new features are accepted. This is the last phase before a release is closed. |
30-
| Servicing | Only essential fixes are made to support the release. a.k.a. maintenance mode |
31-
| Out of service | A previous release, which is no longer receiving updates. |
33+
| Ask Mode | Only critical fixes are allowed; changes are scrutinized. No new features. This is the last phase before a release is closed. |
34+
| Servicing | Only essential fixes are made to support the release (a.k.a. maintenance mode). |
35+
| Out of service | A previous release which is no longer receiving updates. |
3236

3337
### Release branch process
3438

3539
We track the state of candidates for a given release by tagging the PRs with the following labels:
3640

37-
* `backport_YYMM`: This PR (to `main`) is a candidate to be included in the
38-
`YYMM` release.
39-
* N.B.: A maintainer will _remove_ this tag if the fix is not accepted into
40-
the release.
41-
* `backported_YYMM`: This PR (to `main`) has been cherry-picked to the `YYMM`
42-
release.
41+
* `backport_<RELEASE>`: This PR (to `main`) is a candidate to be included in the release.
42+
* N.B.: A maintainer will _remove_ this tag if the fix is not accepted into the release.
43+
* `backported_<RELEASE>`: This PR (to `main`) has been cherry-picked to the release branch.
4344

4445
#### Seeking Approval for Backport
4546

4647
To seek approval to include a change in a release branch, follow these steps:
4748

48-
* Tag your PR to `main` PR with the `backport_YYMM` label.
49-
* Cherry-pick the change to the appropriate `release/YYMM` branch in your fork
50-
and stage a PR to that same branch in the main repository.
49+
1. Tag your PR to `main` with the `backport_<RELEASE>` label.
50+
2. Wait for the PR to be merged to `main`.
51+
3. Cherry-pick the change to the appropriate release branch in your fork and
52+
stage a PR to that same branch in the main repository.
5153

5254
Please reach out to the maintainers before staging that PR if you have any
5355
doubts.
5456

5557
#### Backport PR Best Practices
5658

57-
When creating a backport PR to a `release/YYMM` branch:
59+
When creating a backport PR to a release branch:
5860

5961
* **Clean cherry-picks are strongly preferred.** A clean cherry-pick minimizes
6062
reviewer effort and reduces the risk of introducing regressions.
@@ -69,6 +71,7 @@ When creating a backport PR to a `release/YYMM` branch:
6971
|--------|-------|-------|
7072
| release/2411 | Out of service | |
7173
| release/2505 | Servicing | Supports runtime servicing from release/2411. |
74+
| release/1.7.2511 | Stabilization | Supports runtime servicing from release/2411 and release/2505. |
7275
| _tbd, in main_ | Active Development | Supports runtime servicing from release/2411 and release/2505. |
7376

7477
## Taking a Dependency on a Release

0 commit comments

Comments
 (0)