summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorZuul <zuul@review.opendev.org>2023-01-26 16:28:00 +0000
committerGerrit Code Review <review@openstack.org>2023-01-26 16:28:00 +0000
commitfe2d08d3de5c693beb015b1a1b5badeea4313d78 (patch)
treee02b4a344728f1b9a7aa6785d4429df02b57257a
parent324bb00cb172ae2ac2211209569e9be4578c3755 (diff)
parent38777e5030d17320fa284fd30f7423e19c55d0ac (diff)
downloadironic-fe2d08d3de5c693beb015b1a1b5badeea4313d78.tar.gz
Merge "Clarify release docs: bugfix releases optional"
-rw-r--r--doc/source/contributor/releasing.rst20
1 files changed, 12 insertions, 8 deletions
diff --git a/doc/source/contributor/releasing.rst b/doc/source/contributor/releasing.rst
index eab0649c6..3c0732c5b 100644
--- a/doc/source/contributor/releasing.rst
+++ b/doc/source/contributor/releasing.rst
@@ -125,19 +125,23 @@ openstack ``stable/NAME`` branches:
* ironic-inspector
* ironic-python-agent
-They are also released on a regular cadence as opposed to on-demand, namely
-three times a release cycle (roughly a release every 2 months). One of the
-releases corresponds to the coordinated OpenStack released and receives a
-``stable/NAME`` branch. The other two happen during the cycle and receive a
-``bugfix/X.Y`` branch, where ``X.Y`` consists of the major and the minor
-component of the version (e.g. ``bugfix/8.1`` for 8.1.0).
+These projects receive releases every six months as part of the coordinated
+OpenStack release that happens semi-annually. These releases can be
+found in a ``stable/NAME`` branch.
+
+They are also evaluated for additional bugfix releases between scheduled
+stable releases at the two and four month milestore between stable releases
+(roughly every 2 months). These releases can be found in a ``bugfix/X.Y``
+branch. A bugfix release is only created if there are significant
+beneficial changes and a known downstream operator or distributor will consume
+the release.
To leave some version space for releases from these branches, releases of these
projects from the master branch always increase either the major or the minor
version.
-Currently releases from bugfix branches cannot be automated and must be done by
-the release team manually.
+Currently releases and retirements from bugfix branches cannot be automated and
+must be done by the release team manually.
After the creation of a bugfix branch it is utmost important to update the
upper-constraints link for the tests in the tox.ini file, plus override the