2016-07-11 16:00:37 -04:00
|
|
|
===================
|
|
|
|
Release Processes
|
|
|
|
===================
|
|
|
|
|
|
|
|
This document describes the relative ordering and rough timeline for
|
|
|
|
all of the steps related to preparing the release.
|
|
|
|
|
2017-08-25 15:20:34 -04:00
|
|
|
Before PTG (after closing previous release)
|
|
|
|
===========================================
|
2016-07-11 16:00:37 -04:00
|
|
|
|
2019-05-06 13:31:24 -05:00
|
|
|
#. Set up the release schedule for the newly opened cycle by creating
|
2016-07-11 16:00:37 -04:00
|
|
|
the required pages in openstack/releases.
|
|
|
|
|
2019-05-06 13:31:24 -05:00
|
|
|
#. Update the link to the documentation on the newly opened cycle page
|
2017-08-25 15:20:34 -04:00
|
|
|
to point to the right place on docs.openstack.org.
|
|
|
|
|
2019-05-06 13:31:24 -05:00
|
|
|
#. Create the $series-relmgt-tracking etherpad using ``tools/list_weeks.py``.
|
|
|
|
For example::
|
2016-07-11 16:00:37 -04:00
|
|
|
|
2019-05-06 13:31:24 -05:00
|
|
|
tools/list_weeks.py t 2019-04-15 2019-10-16
|
|
|
|
|
|
|
|
#. Use ``init-series`` to create stub deliverable files based on the
|
2016-12-01 15:40:33 -05:00
|
|
|
contents of the previous release.
|
|
|
|
|
2016-07-11 16:00:37 -04:00
|
|
|
Between Summit and Milestone-1
|
|
|
|
==============================
|
|
|
|
|
2019-05-06 13:31:24 -05:00
|
|
|
#. Establish liaisons by having them update
|
2016-07-11 16:00:37 -04:00
|
|
|
https://wiki.openstack.org/wiki/CrossProjectLiaisons with their
|
|
|
|
contact information.
|
|
|
|
|
2019-05-06 13:31:24 -05:00
|
|
|
#. Email PTLs directly one time to explain the use of the "[release][ptl]"
|
2019-03-22 15:09:44 -05:00
|
|
|
email tag on the openstack-discuss list.
|
2016-07-11 16:00:37 -04:00
|
|
|
|
2019-05-06 13:31:24 -05:00
|
|
|
#. Encourage liaisons to ensure that their release model is set
|
2016-07-11 16:00:37 -04:00
|
|
|
properly before the first milestone.
|
|
|
|
|
2019-05-06 13:31:24 -05:00
|
|
|
#. Start weekly countdown emails, sent right after the team meeting,
|
|
|
|
with information needed about the
|
2017-05-30 10:49:44 +02:00
|
|
|
following week (deadlines, instructions, etc.).
|
2016-07-11 16:00:37 -04:00
|
|
|
|
2019-05-06 13:31:24 -05:00
|
|
|
#. The week before Milestone-1, include a reminder about completing
|
2016-10-17 15:08:36 -04:00
|
|
|
the responses to community-wide goals in the countdown email.
|
|
|
|
|
2016-07-11 16:00:37 -04:00
|
|
|
Milestone-1
|
|
|
|
===========
|
|
|
|
|
2019-05-06 13:31:24 -05:00
|
|
|
#. Generate release requests for all cycle-with-intermediary libraries
|
2019-02-08 15:05:28 +01:00
|
|
|
which had changes, but did not release since the previous release.
|
|
|
|
That patch will be used as a base to communicate with the team:
|
|
|
|
if a team wants to wait for a specific patch to make it to the library,
|
|
|
|
someone from the team can -1 the patch to have it held, or update
|
|
|
|
that patch with a different commit SHA.
|
2016-07-11 16:00:37 -04:00
|
|
|
|
2019-05-06 13:31:24 -05:00
|
|
|
#. To catch if there are acl issues in newly created repositories,
|
|
|
|
run tools/aclissues.py to detect potential leftovers in Gerrit ACLs
|
|
|
|
allowing official deliverables to be directly tagged or branched without
|
2018-07-04 14:13:34 +02:00
|
|
|
going through openstack/releases. You need to specify the location
|
|
|
|
of up-to-date checkouts for the governance and the project-config
|
|
|
|
repositories. For example::
|
|
|
|
|
|
|
|
tools/aclissues.py ../project-config ../governance
|
|
|
|
|
2019-05-06 13:31:24 -05:00
|
|
|
If the tool reports any violation, you can re-run it with ``--patch`` to
|
|
|
|
generate needed changes in ../project-config to align ACLs with governance,
|
|
|
|
and propose the changes for review.
|
|
|
|
|
2016-07-11 16:00:37 -04:00
|
|
|
Between Milestone-1 and Milestone-2
|
|
|
|
===================================
|
|
|
|
|
2019-02-08 15:05:28 +01:00
|
|
|
#. Use the countdown emails to list which projects have not done any
|
2017-05-30 10:49:44 +02:00
|
|
|
stable release yet, to encourage them to do so.
|
|
|
|
|
2019-02-08 15:05:28 +01:00
|
|
|
#. Use the countdown emails to list which intermediary-released (or
|
|
|
|
independent) deliverables haven't done a release yet. Remind teams that
|
|
|
|
intermediary-released services that have not done a release by
|
|
|
|
milestone-2 should be switched to the cycle-with-rc model.
|
2017-05-30 10:49:44 +02:00
|
|
|
|
2019-02-20 19:56:46 +01:00
|
|
|
For this, run::
|
|
|
|
|
|
|
|
tox -e venv -- list-deliverables --unreleased --model cycle-with-intermediary \
|
|
|
|
--type client-library --type horizon-plugin --type library --type other
|
|
|
|
|
2019-02-08 15:05:28 +01:00
|
|
|
#. Mention the upcoming MembershipFreeze deadline in the countdown emails.
|
2016-07-11 16:00:37 -04:00
|
|
|
|
2019-05-06 13:31:24 -05:00
|
|
|
#. Ahead of MembershipFreeze, run ``membership_freeze_test`` to check for
|
2019-01-16 16:56:48 +01:00
|
|
|
any new deliverable in governance that has not been released yet::
|
|
|
|
|
|
|
|
tox -e membership_freeze_test -- $series ~/branches/governance/reference/projects.yaml
|
|
|
|
|
2019-05-06 13:31:24 -05:00
|
|
|
Those should either be tagged as a release management exception if they do
|
|
|
|
not need to be released (see ``release-management`` key in the governance
|
|
|
|
projects.yaml file) or an empty deliverable file should be added to the
|
|
|
|
series so that we can properly track it. Leftovers are considered too young
|
|
|
|
to be released in the next release and will be reconsidered at the next
|
|
|
|
cycle.
|
2019-01-16 16:56:48 +01:00
|
|
|
|
2016-07-11 16:00:37 -04:00
|
|
|
Milestone-2
|
|
|
|
===========
|
|
|
|
|
2019-05-06 13:31:24 -05:00
|
|
|
#. Generate release requests for all cycle-with-intermediary libraries
|
2019-02-08 15:05:28 +01:00
|
|
|
which had changes, but did not release since milestone-1.
|
|
|
|
That patch will be used as a base to communicate with the team:
|
|
|
|
if a team wants to wait for a specific patch to make it to the library,
|
|
|
|
someone from the team can -1 the patch to have it held, or update
|
|
|
|
that patch with a different commit SHA.
|
2016-07-11 16:00:37 -04:00
|
|
|
|
2019-05-06 13:31:24 -05:00
|
|
|
#. To catch if there are acl issues in newly created repositories,
|
|
|
|
run ``tools/aclissues.py`` to detect potential leftovers in Gerrit ACLs
|
|
|
|
allowing official deliverables to be directly tagged or branched without
|
2018-07-04 14:13:34 +02:00
|
|
|
going through openstack/releases. You need to specify the location
|
|
|
|
of up-to-date checkouts for the governance and the project-config
|
|
|
|
repositories. For example::
|
|
|
|
|
|
|
|
tools/aclissues.py ../project-config ../governance
|
|
|
|
|
2019-05-06 13:31:24 -05:00
|
|
|
If the tool reports any violation, you can re-run it with ``--patch`` to
|
|
|
|
generate needed changes in ../project-config to align ACLs with governance,
|
|
|
|
and propose the changes for review.
|
|
|
|
|
2016-07-11 16:00:37 -04:00
|
|
|
Between Milestone-2 and Milestone-3
|
|
|
|
===================================
|
|
|
|
|
2019-02-08 15:05:28 +01:00
|
|
|
#. In the countdown email immediately after Milestone-2, include a
|
2016-07-11 16:00:37 -04:00
|
|
|
reminder about the various freezes that happen around Milestone-3.
|
|
|
|
|
2019-05-06 13:31:24 -05:00
|
|
|
Remind PTLs a heads up to start thinking about what they might want to
|
|
|
|
include in their deliverables file as cycle-highlights
|
|
|
|
and that feature freeze is the deadline for them.
|
|
|
|
|
|
|
|
#. Check with the election team about whether the countdown email
|
|
|
|
needs to include any updates about the election schedule.
|
|
|
|
|
2019-02-08 15:05:28 +01:00
|
|
|
#. For intermediary-released service projects that have not done a
|
|
|
|
release by milestone-2, propose a change from cycle-with-intermediary
|
|
|
|
to cycle-with-rc. Engage with PTLs and release liaisons to either
|
|
|
|
get an intermediary release, or a confirmation of the model switch.
|
|
|
|
|
|
|
|
#. Two weeks before Milestone-3, include a reminder about the final
|
2016-07-11 16:00:37 -04:00
|
|
|
library release freeze coming the week before Milestone-3.
|
|
|
|
|
2019-05-06 13:31:24 -05:00
|
|
|
#. Run the command from milestone-2 again to get a list of libraries::
|
2017-12-28 13:46:35 -06:00
|
|
|
|
|
|
|
tools/list_library_unreleased_changes.sh
|
|
|
|
|
2019-05-06 13:31:24 -05:00
|
|
|
#. Include list of unreleased libraries in the email to increase visibility.
|
2017-12-28 13:46:35 -06:00
|
|
|
|
2019-02-08 15:05:28 +01:00
|
|
|
#. Two weeks before Milestone-3, prepare other teams to the final release
|
2018-03-29 18:46:48 +02:00
|
|
|
rush.
|
2016-07-11 16:00:37 -04:00
|
|
|
|
2019-05-06 13:31:24 -05:00
|
|
|
#. Ask the release liaisons for the affected teams to audit the
|
|
|
|
contents of their ``$project-stable-maint`` groups, as that group
|
|
|
|
will control the ``stable/$series`` branch prior to release. They
|
|
|
|
should reach out to the ``stable-maint-core`` group for additions.
|
|
|
|
|
|
|
|
#. Include a reminder about the stable branch ACLs in the countdown email.
|
2016-07-11 16:00:37 -04:00
|
|
|
|
2019-05-06 13:31:24 -05:00
|
|
|
#. Notify the Infrastructure team to `generate an artifact signing key`_
|
2018-07-17 09:09:11 -04:00
|
|
|
(but not replace the current one yet), and
|
|
|
|
begin the attestation process.
|
|
|
|
|
|
|
|
.. _generate an artifact signing key: https://docs.openstack.org/infra/system-config/signing.html#generation
|
2017-01-06 15:19:51 +00:00
|
|
|
|
2019-05-06 13:31:24 -05:00
|
|
|
#. Include a reminder in the weekly countdown email reminding PTLs of the
|
|
|
|
feature freeze deadline for cycle-highlights.
|
|
|
|
|
2016-07-11 16:00:37 -04:00
|
|
|
Final Library Release (week before Milestone-3)
|
|
|
|
===============================================
|
|
|
|
|
2019-02-08 15:05:28 +01:00
|
|
|
#. Generate release requests for all cycle-with-intermediary libraries
|
|
|
|
(except client libraries) which had changes, but did not release since
|
|
|
|
milestone-2. That patch will be used as a base to communicate with the
|
|
|
|
team: if a team wants to wait for a specific patch to make it to the
|
|
|
|
library, someone from the team can -1 the patch to have it held, or update
|
|
|
|
that patch with a different commit SHA.
|
|
|
|
|
2019-05-06 13:31:24 -05:00
|
|
|
.. note::
|
|
|
|
|
|
|
|
At this point, we want *all* changes in the deliverables, to ensure
|
|
|
|
that we have CI configuration up to date when the stable branch
|
|
|
|
is created later.
|
2016-07-11 16:00:37 -04:00
|
|
|
|
2019-05-06 13:31:24 -05:00
|
|
|
#. Release libraries as quickly as possible this week to ensure they
|
|
|
|
are all done before the freeze.
|
2016-07-11 16:00:37 -04:00
|
|
|
|
2018-08-03 10:59:21 -05:00
|
|
|
#. Update the feature list and allowed stable branch names in
|
2016-08-29 16:49:31 -04:00
|
|
|
devstack-gate for the new stable branch. For
|
2019-05-12 04:31:25 +08:00
|
|
|
example, https://review.opendev.org/362435 and
|
|
|
|
https://review.opendev.org/363084
|
2016-08-29 16:49:31 -04:00
|
|
|
|
2019-05-06 13:31:24 -05:00
|
|
|
#. Allow the ``stable/$series`` branch to be requested with each library final
|
2018-08-03 10:59:21 -05:00
|
|
|
release if they know they are ready. Do not require branching at this point
|
|
|
|
in case of critical issues requiring another approved release past the
|
|
|
|
freeze date.
|
2016-07-11 16:00:37 -04:00
|
|
|
|
|
|
|
Milestone-3
|
|
|
|
===========
|
|
|
|
|
2019-02-08 15:05:28 +01:00
|
|
|
#. Generate release requests for all client libraries which had changes,
|
|
|
|
but did not release since milestone-2. That patch will be used as a base
|
|
|
|
to communicate with the team: if a team wants to wait for a specific patch
|
|
|
|
to make it to the library, someone from the team can -1 the patch to have
|
|
|
|
it held, or update that patch with a different commit SHA.
|
2016-07-11 16:00:37 -04:00
|
|
|
|
2019-05-06 13:31:24 -05:00
|
|
|
#. Evaluate any libraries that did not have any change merged over the
|
|
|
|
cycle to see if it is time to `transition them to the independent release
|
|
|
|
model <https://releases.openstack.org/reference/release_models.html#openstack-related-libraries>`__.
|
|
|
|
|
|
|
|
If it is OK to transition them, move the deliverable file to the ``_independent`` directory.
|
|
|
|
|
|
|
|
If it is not OK to transition them, create a new stable branch from the latest release
|
|
|
|
from the previous series.
|
|
|
|
|
|
|
|
#. Remind the requirements team to freeze changes to
|
|
|
|
``openstack/requirements`` by applying -2 to all
|
2016-09-29 12:11:03 -04:00
|
|
|
open patches. Ensure that reviewers do not approve changes created
|
2019-05-06 13:31:24 -05:00
|
|
|
by the proposal bot, but do approve changes for new OpenStack deliverable
|
|
|
|
releases.
|
2016-07-11 16:00:37 -04:00
|
|
|
|
2019-05-06 13:31:24 -05:00
|
|
|
#. Allow the ``stable/$series`` branch to be requested with each client library
|
2018-08-03 10:59:21 -05:00
|
|
|
final release if they know they are ready. Do not require branching at this
|
|
|
|
point in case of critical issues requiring another approved release past the
|
|
|
|
freeze date.
|
2016-07-11 16:00:37 -04:00
|
|
|
|
2018-08-03 10:59:21 -05:00
|
|
|
#. Remind PTLs/liaisons that master should be frozen except for bug
|
2016-07-11 16:00:37 -04:00
|
|
|
fixes and feature work with FFEs.
|
|
|
|
|
2019-05-06 13:31:24 -05:00
|
|
|
#. Email openstack-discuss list to remind PTLs that cycle-highlights are due
|
|
|
|
this week so that they can be included in release marketing preparations.
|
|
|
|
|
2018-08-03 10:59:21 -05:00
|
|
|
#. Remind PTL/liaisons to start preparing "prelude" release notes as
|
2016-10-07 12:05:00 -04:00
|
|
|
summaries of the content of the release so that those are merged
|
|
|
|
before their first release candidate.
|
|
|
|
|
2018-08-03 10:59:21 -05:00
|
|
|
#. Freeze all cycle-based library releases except for release-critical
|
2017-05-30 10:58:04 +02:00
|
|
|
bugs. Independently-released libraries may still be released, but
|
|
|
|
constraint or requirement changes will be held until after the freeze
|
|
|
|
period.
|
2016-07-11 16:00:37 -04:00
|
|
|
|
2019-05-06 13:31:24 -05:00
|
|
|
.. note::
|
2018-07-04 14:13:34 +02:00
|
|
|
|
2019-05-06 13:31:24 -05:00
|
|
|
Do not release libraries without a link to a message to openstack-discuss
|
|
|
|
requesting a requirements FFE and an approval response from that team.
|
2019-02-11 14:34:25 -08:00
|
|
|
|
2016-07-11 16:00:37 -04:00
|
|
|
Between Milestone-3 and RC1
|
|
|
|
===========================
|
|
|
|
|
2019-05-06 13:31:24 -05:00
|
|
|
#. Warn cycle-with-intermediary services that have releases more than
|
2018-02-02 10:44:46 -05:00
|
|
|
2 months old that we will use their existing release as a point for
|
2019-02-08 15:05:28 +01:00
|
|
|
branching if they have not prepared a newer release by the final RC
|
2018-02-02 10:44:46 -05:00
|
|
|
deadline.
|
|
|
|
|
2019-05-06 13:31:24 -05:00
|
|
|
#. Propose ``stable/$series`` branch creation for all client and non-client
|
2018-08-03 10:59:21 -05:00
|
|
|
libraries that had not requested it at freeze time. The following command
|
|
|
|
may be used::
|
|
|
|
|
|
|
|
tox -e venv -- propose-library-branches --include-clients
|
|
|
|
|
2019-02-08 15:05:28 +01:00
|
|
|
RC1 week
|
|
|
|
========
|
2016-07-11 16:00:37 -04:00
|
|
|
|
2019-02-08 15:05:28 +01:00
|
|
|
#. Early in the week, generate RC1 release requests (including the
|
2019-05-06 13:31:24 -05:00
|
|
|
``stable/$series`` branch creation) for all cycle-with-rc deliverables.
|
2019-02-08 15:05:28 +01:00
|
|
|
That patch will be used as a base to communicate with the team:
|
|
|
|
if a team wants to wait for a specific patch to make it to the RC,
|
|
|
|
someone from the team can -1 the patch to have it held, or update
|
|
|
|
that patch with a different commit SHA.
|
2016-07-11 16:00:37 -04:00
|
|
|
|
2019-06-20 12:24:54 +02:00
|
|
|
#. Generate release requests (without ``stable/$series`` branch creation)
|
|
|
|
for all cycle-automatic deliverables.
|
|
|
|
|
2019-02-08 15:05:28 +01:00
|
|
|
#. By the end of the week, ideally we would want a +1 from the PTL and/or
|
|
|
|
release liaison to indicate approval. However we will consider the absence
|
|
|
|
of -1 or otherwise negative feedback as an indicator that the automatically
|
|
|
|
proposed patches can be approved at the end of the RC deadline week.
|
2016-09-19 09:59:47 -04:00
|
|
|
|
2019-05-06 13:31:24 -05:00
|
|
|
#. After all the projects enabled in devstack by default have been branched,
|
|
|
|
remind the QA PTL to create a branch in the devstack repository. Devstack
|
|
|
|
doesn't push a tag at RC1 it is just branched off of HEAD.
|
2016-09-08 16:45:41 -04:00
|
|
|
|
2019-05-06 13:31:24 -05:00
|
|
|
#. After devstack is branched, remind the QA PTL to create a branch in the
|
|
|
|
grenade repository. As with devstack, it will branch from HEAD instead of a
|
|
|
|
tag.
|
2016-09-08 16:45:41 -04:00
|
|
|
|
2019-05-06 13:31:24 -05:00
|
|
|
#. Remind the QA PTL to update the default branch for devstack in the new
|
|
|
|
stable branch. For example, https://review.opendev.org/#/c/493208/
|
2017-08-11 16:29:03 -04:00
|
|
|
|
2019-05-06 13:31:24 -05:00
|
|
|
#. Remind the QA PTL to update the grenade settings in devstack-gate for the
|
|
|
|
new branch. For example, https://review.opendev.org/362438.
|
2016-08-29 16:49:31 -04:00
|
|
|
|
2019-02-08 15:05:28 +01:00
|
|
|
.. note::
|
|
|
|
|
2019-05-06 13:31:24 -05:00
|
|
|
As soon as grenade is updated for the new branch (see the RC1
|
|
|
|
instructions that follow), projects without stable branches may
|
|
|
|
start seeing issues with their grenade jobs because without the
|
|
|
|
stable branch the branch selection will cause the jobs to run
|
|
|
|
master->master instead of previous->master. At the end of Ocata
|
|
|
|
this caused trouble for the Ironic team, for example.
|
2016-09-29 21:02:07 +02:00
|
|
|
|
2019-05-06 13:31:24 -05:00
|
|
|
#. Remind the I18n PTL to update the translation tools for the new stable
|
|
|
|
series.
|
2016-09-29 21:02:07 +02:00
|
|
|
|
2019-05-06 13:31:24 -05:00
|
|
|
#. After all cycle-with-rc projects have their branches created, remind the
|
|
|
|
requirements PTL to propose an update to the deliverable file to create the
|
|
|
|
``stable/$series`` branch for ``openstack/requirements``. Then announce that
|
|
|
|
the requirements freeze is lifted from master.
|
2016-07-11 16:00:37 -04:00
|
|
|
|
2018-07-17 09:09:11 -04:00
|
|
|
.. note::
|
|
|
|
|
2019-05-06 13:31:24 -05:00
|
|
|
We wait until after the other projects have branched to
|
|
|
|
create the branch for requirements because tests for the stable
|
|
|
|
branches of those projects will fall back to using the master
|
|
|
|
branch of requirements until the same stable branch is created,
|
|
|
|
but if the branch for the requirements repo exists early the
|
|
|
|
changes happening in master on the other projects will not use it
|
|
|
|
and we can have divergence between the requirements being tested
|
|
|
|
and being declared as correct.
|
|
|
|
|
|
|
|
#. Remind the QA PTL to create new branch specific jobs for our two branchless
|
|
|
|
projects, devstack-gate and tempest, in the tempest repo. Configure tempest
|
|
|
|
to run them on all changes, voting. Configure tempest to run them as
|
|
|
|
periodic bitrot jobs as well. All this can be done in one tempest patch,
|
2019-05-12 04:31:25 +08:00
|
|
|
for example, see https://review.opendev.org/521888.
|
2018-02-16 11:16:40 +00:00
|
|
|
Configure devstack-gate to run the new jobs in check pipeline only,
|
2019-05-12 04:31:25 +08:00
|
|
|
non-voting, for example see https://review.opendev.org/545144.
|
2016-08-30 13:56:55 -07:00
|
|
|
|
2019-05-06 13:31:24 -05:00
|
|
|
#. Remind the QA PTL to add the new branch to the list of branches in the
|
|
|
|
periodic-stable job templates in openstack-zuul-jobs. For example, see
|
2019-05-12 04:31:25 +08:00
|
|
|
https://review.opendev.org/545268/.
|
2016-08-30 13:56:55 -07:00
|
|
|
|
2016-07-11 16:00:37 -04:00
|
|
|
Between RC1 and Final
|
|
|
|
=====================
|
|
|
|
|
2019-02-08 15:05:28 +01:00
|
|
|
#. In the countdown email, remind everyone that the latest RC (for
|
|
|
|
cycle-with-rc deliverables) or the latest intermediary release (for
|
|
|
|
cycle-with-intermediary deliverables) will automatically be used as
|
|
|
|
the final $series release on release day.
|
2016-07-11 16:00:37 -04:00
|
|
|
|
2019-02-08 15:05:28 +01:00
|
|
|
#. Let cycle-with-rc projects iterate on RCs as needed. The final release
|
|
|
|
candidate for each project needs to be prepared at least one week before
|
|
|
|
the final release date.
|
|
|
|
|
|
|
|
.. note::
|
|
|
|
|
2019-05-06 13:31:24 -05:00
|
|
|
Try to avoid creating more than 3 release candidates so we are not
|
|
|
|
creating candidates that consumers are then trained to ignore. Each
|
|
|
|
release candidate should be kept for at least 1 day, so if there is a
|
|
|
|
proposal to create RCx but clearly a reason to create another one,
|
|
|
|
delay RCX to include the additional patches. Teams that know they will
|
|
|
|
need additional release candidates can submit the requests and mark
|
|
|
|
them WIP until actually ready, so the release team knows that more
|
|
|
|
candidates are coming.
|
2019-02-08 15:05:28 +01:00
|
|
|
|
|
|
|
#. Ensure that all projects that are publishing release notes have the
|
2016-09-22 16:48:58 -04:00
|
|
|
notes link included in their deliverable file. See
|
|
|
|
``tools/add_release_note_links.sh``.
|
2016-07-11 16:00:37 -04:00
|
|
|
|
2019-02-08 15:05:28 +01:00
|
|
|
#. Encourage liaisons to merge all translation patches.
|
2016-09-22 16:48:58 -04:00
|
|
|
|
2019-02-08 15:05:28 +01:00
|
|
|
#. When all translations and bug fixes are merged for a project,
|
2016-07-11 16:00:37 -04:00
|
|
|
prepare a new release candidate.
|
|
|
|
|
2019-02-08 15:05:28 +01:00
|
|
|
#. After final releases for release:cycle-with-intermediary projects
|
2016-09-15 14:59:22 -04:00
|
|
|
are tagged, create their stable branches.
|
|
|
|
|
2019-02-08 15:05:28 +01:00
|
|
|
#. On the morning of the deadline for final release candidates, check
|
2019-03-27 13:54:24 -04:00
|
|
|
the list of unreleased changes for cycle-with-rc projects and verify
|
2016-09-29 13:52:41 -04:00
|
|
|
with the PTLs and liaisons that they are planning a release or that
|
|
|
|
they do not need one.
|
|
|
|
|
2019-03-27 13:54:24 -04:00
|
|
|
In the releases repository working directory, run::
|
2016-09-29 13:52:41 -04:00
|
|
|
|
2019-03-27 13:54:24 -04:00
|
|
|
$ ./tools/list_rc_updates.sh
|
2016-09-29 13:52:41 -04:00
|
|
|
|
2019-02-08 15:05:28 +01:00
|
|
|
#. Propose stable/$series branch creation for deliverables that have not
|
|
|
|
requested it yet.
|
2018-06-27 16:15:30 +02:00
|
|
|
|
2019-02-08 15:05:28 +01:00
|
|
|
#. As soon as the last release candidate is tagged and the freeze
|
2016-10-07 12:08:55 -04:00
|
|
|
period is entered, use ``propose-final-releases`` to tag the
|
|
|
|
existing most recent release candidates as the final release for
|
2018-09-30 13:15:57 -05:00
|
|
|
projects using the cycle-with-rc model.
|
2016-10-07 12:08:55 -04:00
|
|
|
|
2019-02-08 15:05:28 +01:00
|
|
|
#. Ask liaisons and PTLs of milestone-based projects to review and +1
|
2016-10-07 12:08:55 -04:00
|
|
|
the final release proposal from the previous step so their approval
|
|
|
|
is included in the metadata that goes onto the signed tag.
|
|
|
|
|
2019-02-08 15:05:28 +01:00
|
|
|
#. The week before final release test the release process using the
|
2019-05-06 13:31:24 -05:00
|
|
|
``openstack/release-test`` repository to ensure our machinery is functional.
|
2016-11-30 13:49:55 -05:00
|
|
|
|
2019-02-08 15:05:28 +01:00
|
|
|
#. Notify the documentation team that it should be safe to apply
|
|
|
|
their process to create the new release series landing pages for
|
|
|
|
docs.openstack.org. Their process works better if they wait until
|
|
|
|
most of the projects have their stable branches created, but they
|
|
|
|
can do the work before the final release date to avoid having to
|
|
|
|
synchronize with the release team on that day.
|
2017-07-31 12:01:24 -04:00
|
|
|
|
2016-07-11 16:00:37 -04:00
|
|
|
Final Release
|
|
|
|
=============
|
|
|
|
|
2019-05-06 13:31:24 -05:00
|
|
|
#. Approve the final release patch created earlier.
|
|
|
|
|
|
|
|
.. note::
|
|
|
|
|
|
|
|
This needs to happen several hours before the press release
|
|
|
|
from the foundation (to give us time to handle failures) but not
|
|
|
|
too far in advance (to avoid releasing the day before the press
|
|
|
|
release).
|
2016-10-07 12:31:33 -04:00
|
|
|
|
2019-05-06 13:31:24 -05:00
|
|
|
#. Run the ``missing-releases`` script to check for missing tarballs on the
|
2018-02-28 18:08:27 +01:00
|
|
|
release page before the announcement::
|
|
|
|
|
|
|
|
tox -e venv -- missing-releases --series $SERIES
|
|
|
|
|
2019-05-06 13:31:24 -05:00
|
|
|
If there are any missing deliverables, fix them.
|
|
|
|
|
|
|
|
#. Mark series as released on releases.o.o, by updating doc/source/index.rst
|
2017-02-22 08:23:32 -05:00
|
|
|
and doc/source/$series/index.rst.
|
2019-05-12 04:31:25 +08:00
|
|
|
See https://review.opendev.org/#/c/381006 for an example.
|
2017-02-22 08:23:32 -05:00
|
|
|
|
2019-05-06 13:31:24 -05:00
|
|
|
.. note::
|
|
|
|
|
|
|
|
This item can be staged as a patch on top of the final release patch.
|
|
|
|
|
|
|
|
#. Update the default series name in
|
2016-08-26 14:14:49 -04:00
|
|
|
``openstack/releases/openstack_releases/defaults.py`` to use the
|
|
|
|
new series name.
|
2016-09-26 15:42:39 -04:00
|
|
|
|
2019-05-06 13:31:24 -05:00
|
|
|
.. note::
|
|
|
|
|
|
|
|
This item can be staged as a patch on top of the previous patch.
|
|
|
|
Only workflow when previous step *fully* ready
|
|
|
|
|
|
|
|
#. Send release announcement email to
|
2017-02-28 11:00:01 -05:00
|
|
|
``openstack-announce@lists.openstack.org``, based on
|
|
|
|
``templates/final.txt``. Coordinate the timing of the email with
|
|
|
|
the press release from the Foundation staff.
|
|
|
|
|
2019-05-06 13:31:24 -05:00
|
|
|
#. Send an email to the openstack-discuss list to point to the official
|
|
|
|
release announcement from the previous step, and declare
|
|
|
|
``openstack/releases`` unfrozen for releases on the new series.
|
2016-09-26 15:42:51 -04:00
|
|
|
|
|
|
|
Post-Final Release
|
|
|
|
==================
|
|
|
|
|
2018-09-04 12:09:38 -05:00
|
|
|
#. The week after the final release, process any late or blocked
|
2016-09-26 15:42:51 -04:00
|
|
|
release requests for deliverables for any branch (treating the new
|
|
|
|
series branch as stable).
|
2016-10-07 12:33:43 -04:00
|
|
|
|
2019-03-22 15:09:44 -05:00
|
|
|
#. Prepare for the next release cycle by adding deliverable files under the
|
|
|
|
next cycle's directory. Remove any deliverable files from the current cycle
|
|
|
|
that ended up not having any releases. Then run the following command to use
|
|
|
|
the current cycle deliverables to generate placeholders for the next cycle::
|
|
|
|
|
|
|
|
tox -e venv -- init-series $SERIES $NEXT_SERIES
|
|
|
|
|
2019-05-06 13:31:24 -05:00
|
|
|
#. Remind PTLs of cycle-trailing projects to prepare their releases.
|
2016-10-07 12:33:43 -04:00
|
|
|
|