Skip to content

Commit 0d959e2

Browse files
Chris Friedtcfriedt
authored andcommitted
doc: release: elaborate on stabilization period and feature feeze
Elaborate on the stabilization period before release (aka feature freeze), add a section regarding exceptions and gaining approval by the Change Review Board (CRB). Additionally, elaborate on the Release Checklist. Signed-off-by: Chris Friedt <[email protected]>
1 parent 960cd4b commit 0d959e2

File tree

1 file changed

+16
-8
lines changed

1 file changed

+16
-8
lines changed

doc/release.md

Lines changed: 16 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -23,13 +23,20 @@ We add pre-release tags using the format `MAJOR.MINOR.PATCH-EXTRAVERSION`.
2323
2424
## Release candidates
2525

26-
Before each release, tags are made (see below) for at least one release candidate (`a.b.c-rc1`,
27-
followed by `a.b.c-rc2` and the subsequent release candidates, followed by the official `a.b.c`
28-
release). The intent is to freeze the code and allow testing.
26+
A stabilization period will occur prior to each release, where tags are made (see below) for at
27+
least one release candidate, `a.b.c-rc1`. If needed, additional release candidates `a.b.c-rc2`
28+
may be made, ultimately followed by the official and final `a.b.c` release.
2929

30-
During the time between the `rc1` and the final release, the only changes that should be merged into
31-
the `main` branch are those to fix bugs found in the release candidate, to correct documentation,
32-
or to make other cosmetic fixes.
30+
During the stabilization period between `rc1` and the final release, the only changes that should
31+
be merged into the `main` branch are to improve testing, fix bugs, correct documentation and other
32+
cosmetic fixes, and explicitly not to introduce other major changes or features. The stabilization
33+
period is effectively a feature freeze.
34+
35+
### Exceptions
36+
37+
Features may only be merged during the stabilization period with the explicit approval of the
38+
Change Review Board (CRB). The author of the change must accompany the Release Manager (RM) to a
39+
CRB meeting to provide justification for merging the change and to seek CRB approval.
3340

3441
## Release Procedure
3542

@@ -38,8 +45,9 @@ The following steps are required to be followed by firmware release engineers wh
3845

3946
### Release Checklist
4047

41-
Refer to the previous release checklist for steps required before tagging release candidates and
42-
final releases.
48+
Create an issue with the title `Release Checklist va.b.c`. If the issue does not already exist,
49+
then create it using the previous release checklist as a template. The checklist will list the
50+
steps required before tagging a final release.
4351

4452
### Tagging
4553

0 commit comments

Comments
 (0)