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 <sean.mcginnis@gmail.com>
This commit is contained in:
Sean McGinnis 2018-09-30 13:15:57 -05:00
parent 32afc4160d
commit 6369060496
No known key found for this signature in database
GPG Key ID: CE7EE4BFAF8D70C8
4 changed files with 48 additions and 30 deletions

View File

@ -269,7 +269,7 @@ RC1
Note this work is done by translation team. 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 created, someone from the requirements core team (preferably the
requirements PTL) needs to propose an update the deliverable file to requirements PTL) needs to propose an update the deliverable file to
create the stable/$series branch for ``openstack/requirements``. create the stable/$series branch for ``openstack/requirements``.
@ -333,7 +333,7 @@ candidates are coming.
In the release-tools repository working directory, run:: 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 7. After the deadline for final release candidates has passed, create
stable branches for cycle-with-intermediary projects that did not 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 8. As soon as the last release candidate is tagged and the freeze
period is entered, use ``propose-final-releases`` to tag the period is entered, use ``propose-final-releases`` to tag the
existing most recent release candidates as the final release for 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 9. Ask liaisons and PTLs of milestone-based projects to review and +1
the final release proposal from the previous step so their approval the final release proposal from the previous step so their approval

View File

@ -23,7 +23,7 @@ it falls in:
* Components appearing in the *openstack* bucket in the `OpenStack map`_ * Components appearing in the *openstack* bucket in the `OpenStack map`_
form the main components of an OpenStack cloud, and therefore should follow 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. or `cycle-with-intermediary`_ models.
* Libraries cannot use RCs or trail the release. They need to pick between * Libraries cannot use RCs or trail the release. They need to pick between
`cycle-with-intermediary`_ and `independent`_ release models based on how `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 .. _`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 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 single release at the end of the cycle, with development milestones
published at predetermined times in the cycle schedule. 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 milestones following a predetermined schedule published by the Release
Management team before the start of the 6-month cycle. 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. 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. 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 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 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 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. recommend dropping it from the official project list.
.. _cycle-with-intermediary: .. _cycle-with-intermediary:

View File

@ -171,7 +171,7 @@ matches the most recent release from that repository. To re-tag in
those cases, use the --force option. those cases, use the --force option.
Use the --stable-branch option to also create a stable branch for the 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 model automatically receive a new stable branch on their first release
candidate. candidate.
@ -255,7 +255,7 @@ that deliverable. For each deliverable, we need to track:
* cycle highlights that will be published to * cycle highlights that will be published to
``releases.openstack.org/$SERIES/highlights.html`` (optional, and for ``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) only)
* the starting points of all branches * the starting points of all branches

View File

@ -78,10 +78,7 @@ cycle 10 - 14 September in Denver, Colorado, USA.
Stein-1 milestone Stein-1 milestone
----------------- -----------------
25 October 2018 is the Stein-1 milestone window for projects following the 25 October 2018 is the Stein-1 milestone.
`release:cycle-with-milestones`_ model.
.. _release:cycle-with-milestones: https://releases.openstack.org/reference/release_models.html#cycle-with-milestones
.. _s-goals-ack: .. _s-goals-ack:
@ -107,8 +104,7 @@ next development cycle (Stein).
Stein-2 milestone Stein-2 milestone
----------------- -----------------
10 January 2019 is the Stein-2 milestone window for projects following the 10 January 2019 is the Stein-2 milestone.
`release:cycle-with-milestones`_ model.
.. _s-final-lib: .. _s-final-lib:
@ -124,8 +120,7 @@ changes before feature freeze.
Stein-3 milestone Stein-3 milestone
----------------- -----------------
28 February 2019 is the Stein-3 milestone window for projects following the 28 February 2019 is the Stein-3 milestone.
`release:cycle-with-milestones`_ model.
.. _s-goals-complete: .. _s-goals-complete:
@ -142,7 +137,7 @@ Feature freeze
-------------- --------------
The Stein-3 milestone marks feature freeze for projects following the 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. after this point. Exceptions may be granted by the project PTL.
.. _s-rf: .. _s-rf:
@ -179,10 +174,7 @@ is published).
Membership Freeze Membership Freeze
----------------- -----------------
Projects must participate in at least two milestones in order to be considered Projects made official after the second milestone, are not 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
part of the release for the cycle. This does not apply to cycle-trailing part of the release for the cycle. This does not apply to cycle-trailing
packaging / lifecycle management projects. packaging / lifecycle management projects.
@ -192,9 +184,11 @@ RC1 target week
--------------- ---------------
This week is the target for projects following the 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. 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: .. _s-hard-sf:
Hard StringFreeze Hard StringFreeze