From 63690604966419e1a32315ea78b244d95e53a17c Mon Sep 17 00:00:00 2001 From: Sean McGinnis Date: Sun, 30 Sep 2018 13:15:57 -0500 Subject: [PATCH] Update docs with cycle-with-rc information Adds descriptions and references to the cycle-with-rc model. Change-Id: I734a9344ce6b2456611708e59bbdd32c0403400e Signed-off-by: Sean McGinnis --- doc/source/reference/process.rst | 6 ++-- doc/source/reference/release_models.rst | 46 +++++++++++++++++++------ doc/source/reference/using.rst | 4 +-- doc/source/stein/schedule.rst | 22 +++++------- 4 files changed, 48 insertions(+), 30 deletions(-) diff --git a/doc/source/reference/process.rst b/doc/source/reference/process.rst index 3c2b2d2c91..57a19a7897 100644 --- a/doc/source/reference/process.rst +++ b/doc/source/reference/process.rst @@ -269,7 +269,7 @@ RC1 Note this work is done by translation team. -7. After all cycle-with-milestone projects have their branches +7. After all cycle-with-rc projects have their branches created, someone from the requirements core team (preferably the requirements PTL) needs to propose an update the deliverable file to create the stable/$series branch for ``openstack/requirements``. @@ -333,7 +333,7 @@ candidates are coming. In the release-tools repository working directory, run:: - $ ./list_unreleased_changes.sh stable/newton $(list-repos --tag release:cycle-with-milestones) 2>&1 | tee unreleased.log + $ ./list_unreleased_changes.sh stable/newton $(list-repos --tag release:cycle-with-rc) 2>&1 | tee unreleased.log 7. After the deadline for final release candidates has passed, create stable branches for cycle-with-intermediary projects that did not @@ -343,7 +343,7 @@ candidates are coming. 8. As soon as the last release candidate is tagged and the freeze period is entered, use ``propose-final-releases`` to tag the existing most recent release candidates as the final release for - projects using the cycle-with-milestone model. + projects using the cycle-with-rc model. 9. Ask liaisons and PTLs of milestone-based projects to review and +1 the final release proposal from the previous step so their approval diff --git a/doc/source/reference/release_models.rst b/doc/source/reference/release_models.rst index f84fcb7534..3e24139864 100644 --- a/doc/source/reference/release_models.rst +++ b/doc/source/reference/release_models.rst @@ -23,7 +23,7 @@ it falls in: * Components appearing in the *openstack* bucket in the `OpenStack map`_ form the main components of an OpenStack cloud, and therefore should follow - the release cycle. They need to pick between `cycle-with-milestones`_ + the release cycle. They need to pick between `cycle-with-rc`_ or `cycle-with-intermediary`_ models. * Libraries cannot use RCs or trail the release. They need to pick between `cycle-with-intermediary`_ and `independent`_ release models based on how @@ -35,29 +35,53 @@ it falls in: .. _`OpenStack map`: https://www.openstack.org/openstack-map +.. _cycle-with-rc: + +cycle-with-rc +============= + +The "cycle-with-rc" model describes projects that produce a single release at +the end of the cycle, with one or more release candidates (RC) close to the end +of the cycle and optional development milestone betas published on a +per-project need. + +* "cycle-with-rc" projects commit to publish at least one release candidate + following a predetermined schedule published by the Release Management team + before the start of the cycle. +* "cycle-with-rc" projects commit to produce a release to match the end of the + development cycle. +* Release tags for deliverables using this tag are reviewed and applied by the + Release Management team. + .. _cycle-with-milestones: -cycle-with-milestones -===================== +cycle-with-milestones (legacy) +============================== -The "cycle-with-milestones" model describes projects that produce a +.. note:: + + The cycle-with-milestones release model is no longer used and is kept here + for historical reference. Projects should now use cycle-with-rc. + + +The "cycle-with-milestones" model described projects that produced a single release at the end of the cycle, with development milestones published at predetermined times in the cycle schedule. -* "cycle-with-milestones" projects commit to publish development +* "cycle-with-milestones" projects commited to publish development milestones following a predetermined schedule published by the Release Management team before the start of the 6-month cycle. -* "cycle-with-milestones" projects commit to produce a release to +* "cycle-with-milestones" projects commited to produce a release to match the end of the 6-month development cycle. -* Release tags for deliverables using this tag are reviewed and +* Release tags for deliverables using this tag were reviewed and applied by the Release Management team. -* Projects using milestones are expected to tag at least 2 out of the +* Projects using milestones were expected to tag at least 2 out of the 3 for each cycle, or risk being dropped as an official project. The - release team will remind projects that miss the first milestone, and + release team would remind projects that miss the first milestone, and create tags on any later milestones for the project team by tagging - HEAD at the time of the deadline. If the release team force-creates + HEAD at the time of the deadline. If the release team force-created 2 tags for a project in the same given development cycle, the - project will be treated as inactive and the release team will + project would be treated as inactive and the release team would recommend dropping it from the official project list. .. _cycle-with-intermediary: diff --git a/doc/source/reference/using.rst b/doc/source/reference/using.rst index 423e3a9947..c358725e10 100644 --- a/doc/source/reference/using.rst +++ b/doc/source/reference/using.rst @@ -171,7 +171,7 @@ matches the most recent release from that repository. To re-tag in those cases, use the --force option. Use the --stable-branch option to also create a stable branch for the -new release. Projects following the cycle-with-milestones release +new release. Projects following the cycle-with-rc release model automatically receive a new stable branch on their first release candidate. @@ -255,7 +255,7 @@ that deliverable. For each deliverable, we need to track: * cycle highlights that will be published to ``releases.openstack.org/$SERIES/highlights.html`` (optional, and for - cycle-with-intermediary, cycle-with-milestones, and cycle-trailing projects + cycle-with-intermediary, cycle-with-rc, and cycle-trailing projects only) * the starting points of all branches diff --git a/doc/source/stein/schedule.rst b/doc/source/stein/schedule.rst index 575f54591f..9d3a3ee70c 100644 --- a/doc/source/stein/schedule.rst +++ b/doc/source/stein/schedule.rst @@ -78,10 +78,7 @@ cycle 10 - 14 September in Denver, Colorado, USA. Stein-1 milestone ----------------- -25 October 2018 is the Stein-1 milestone window for projects following the -`release:cycle-with-milestones`_ model. - -.. _release:cycle-with-milestones: https://releases.openstack.org/reference/release_models.html#cycle-with-milestones +25 October 2018 is the Stein-1 milestone. .. _s-goals-ack: @@ -107,8 +104,7 @@ next development cycle (Stein). Stein-2 milestone ----------------- -10 January 2019 is the Stein-2 milestone window for projects following the -`release:cycle-with-milestones`_ model. +10 January 2019 is the Stein-2 milestone. .. _s-final-lib: @@ -124,8 +120,7 @@ changes before feature freeze. Stein-3 milestone ----------------- -28 February 2019 is the Stein-3 milestone window for projects following the -`release:cycle-with-milestones`_ model. +28 February 2019 is the Stein-3 milestone. .. _s-goals-complete: @@ -142,7 +137,7 @@ Feature freeze -------------- The Stein-3 milestone marks feature freeze for projects following the -`release:cycle-with-milestones`_ model. No featureful patch should be landed +`release:cycle-with-rc`_ model. No featureful patch should be landed after this point. Exceptions may be granted by the project PTL. .. _s-rf: @@ -179,10 +174,7 @@ is published). Membership Freeze ----------------- -Projects must participate in at least two milestones in order to be considered -part of the release. Projects made official after the second milestone, or -which fail to produce milestone releases for at least one of the first and -second milestones as well as the third milestone, are therefore not considered +Projects made official after the second milestone, are not considered part of the release for the cycle. This does not apply to cycle-trailing packaging / lifecycle management projects. @@ -192,9 +184,11 @@ RC1 target week --------------- This week is the target for projects following the -`release:cycle-with-milestones`_ model to issue their first release candidate, +`release:cycle-with-rc`_ model to issue their first release candidate, with a deadline of 21 March 2019. +.. _release:cycle-with-rc: https://releases.openstack.org/reference/release_models.html#cycle-with-rc + .. _s-hard-sf: Hard StringFreeze