Debian Codegraph @

releasenotes/source/README.txt

raw
1 =========================================
2 Important Notes Regarding Closed Branches
3 =========================================
4
5 This README applies to release notes for branches that are closed. This
6 includes End of Life, Unmaintained, and Extended Maintenance branches.
7 The list of series, and their stable status, can be found here:
8
9 https://releases.openstack.org/
10
11 Once a stable series reaches Extended Maintenance, no new official releases
12 will be performed for that series. For this reason, and to save a significant
13 amount of time in gate jobs that build release notes, EOL branch release
14 notes are made static. Said another way, reno is no longer used to dynamically
15 generate the release notes for that branch as they are not expected to change
16 often.
17
18 Branches in Extended Maintenance will not be released, but they can still
19 accept backports of bugfixes. We may want to include release notes for these
20 fixes, even if they will not be included in an official release. In this case,
21 in addition to backporting the release note, you will need to manually refresh
22 the static page so those new notes will show up under a development release
23 version in the generated output.
24
25 To regenerate the static landing pages in this case, run the following commands
26 from the root of the openstack/cinder repo::
27
28 tox -e releasenotes --notest
29 .tox/releasenotes/bin/reno report \
30 --title "$SERIES Series Release Notes" \
31 --branch "stable/$series" | \
32 sed 's/^ *$//g' > "releasenotes/source/$series.rst"
33
34 In this example, ``$SERIES`` would be the title-cased series name (i.e. Rocky),
35 and $series would be the series name in lower case (i.e. rocky).
36
37 This should replace the static release note page. That page should then be
38 added to the commit and included as part of the review.