Jump to: navigation, search

Difference between revisions of "ReleaseTeam/How To Release"

m (MP cut (switch master to next version))
 
(41 intermediate revisions by 3 users not shown)
Line 1: Line 1:
__NOTOC__
+
{{ caution|http://git.openstack.org/cgit/openstack-infra/release-tools/tree/README.rst|Information here is obsolete.You should read instead: }}
Raw notes for release monkeys in case I end up under a bus.
 
  
All tools mentioned here can be grabbed from this [https://github.com/ttx/openstack-releasing github repo].
+
You can find all tools mentioned here in the [http://git.openstack.org/cgit/openstack-infra/release-tools openstack-infra/release-tools] repository.
  
= Milestone publication =
+
__TOC__
  
(also works for Swift interim releases)
+
== Development milestone publication ==
  
 
<pre><nowiki>
 
<pre><nowiki>
PROJECT=nova         # or PROJECT=swift
+
PROJECT=nova
DEVVERSION=2013.1    # or DEVVERSION=1.8.1
+
MILESTONE=juno-3
MILESTONE=grizzly-3   # or MILESTONE=1.8.1
 
PUBVERSION=2013.1.g3  # or PUBVERSION=1.8.1
 
 
</nowiki></pre>
 
</nowiki></pre>
  
=== Pre-flight checks ===
 
  
==== Missing files check ====
+
==== Pre-flight checks ====
 +
 
 +
 
 +
'''Missing files check''' (for all integrated projects doing the milestone)
 
<pre><nowiki>
 
<pre><nowiki>
 
./repo_tarball_diff.sh $PROJECT master
 
./repo_tarball_diff.sh $PROJECT master
 
</nowiki></pre>
 
</nowiki></pre>
  
==== Tarball/version status ====
 
* Check that the $PROJECT-[branch-]tarball jenkins jobs work properly and that they produce the right version numbers
 
  
==== Check bugs ====
+
==== Milestone tag/publication (between Tuesday and Thursday) ====
* Look at the list of FixCommitted bugs, sanity-check that they were fixed during the period
+
 
 +
All the integrated projects, as well as oslo-incubator and oslo.messaging, need to follow this process sometimes during the milestone publication window.
 +
 
 +
NB: The milestone.sh script special-cases oslo-incubator (where no tarball is published) and oslo.messaging (where no tag is pushed and no tarball is published) so you can just run the same commands with them.
 +
 
  
==== Get PTL signoff ====
+
'''Get PTL signoff''' (for all except oslo.messaging)
* For Swift, check that the $DEVVERSION changelog was committed to master
+
* PTL confirms SHA for tag
* For Swift, set next version on master branch, get it approved by swift-core and make sure it's merged
 
* Note down MP cut commit id
 
  
=== MP cut (Tuesday) ===
 
  
==== Deferring blueprints ====
+
'''Deferring blueprints and bugs'''
* Move all incomplete blueprints to the next milestone
+
* Move all incomplete blueprints to the next milestone ($MILESTONE should all be 'Implemented')
* Move all non-milestone-critical bugs to the next milestone
+
* Move all incomplete bugs to the next milestone ($MILESTONE should all be 'Fix Committed'). You can use the following script:
  
==== Create MP branch from previous commit ====
+
<pre><nowiki>
* Use review.openstack.org admin panel to create branch
+
./process_bugs.py $PROJECT --milestone $MILESTONE --settarget $NEXTMILESTONE
* Branch name is "milestone-proposed", initial revision is the MP cut commit id (or HEAD)
+
</nowiki></pre>
  
==== Process FixCommitted bugs ====
+
 
 +
'''Tag, wait for tarball build, process FixCommitted bugs, check similarities and upload (if applicable)'''
 
<pre><nowiki>
 
<pre><nowiki>
./process_bugs.py $PROJECT --settarget=$MILESTONE --fixrelease
+
./milestone.sh $MILESTONE $SHA $PROJECT
 
</nowiki></pre>
 
</nowiki></pre>
  
==== Wait for tarball build ====
 
* Wait for the $PROJECT-branch-tarball job run to generate a $PROJECT-milestone-proposed.tar.gz
 
  
==== Announce candidate builds (once all done) ====
+
NB: for oslo.messaging $SHA is not used for tagging and is therefore ignored.
 +
 
 +
 
 +
==== When all projects are done ====
 +
 
 +
'''Announce milestone'''
 
* Email to openstack general ML
 
* Email to openstack general ML
 
* Twitter
 
* Twitter
  
=== In the next days (Wednesday-Thursday) ===
 
  
==== Track milestone-critical fixes ====
+
== Swift intermediary releases ==
* Target milestone-critical fixes to $MILESTONE
+
 
* Backport them to milestone-proposed (see [[GerritJenkinsGithub#Authoring_Changes_for_milestone-proposed|how to do it]])
+
<pre><nowiki>
 +
PROJECT=swift
 +
MILESTONE=1.8.1
 +
</nowiki></pre>
  
==== Get PTL signoff ====
 
* For Swift, push change to swift/__init__.py which sets FINAL=True on milestone-proposed branch
 
* Note down milestone cut commit id
 
  
=== Milestone publication (Thursday) ===
+
==== Pre-flight checks ====
  
==== Push tag to MP ====
+
'''Missing files check'''
 
<pre><nowiki>
 
<pre><nowiki>
git checkout -t -b milestone-proposed origin/milestone-proposed
+
./repo_tarball_diff.sh swift master
git pull
 
git tag -s "$PUBVERSION"
 
git push --tags gerrit
 
 
</nowiki></pre>
 
</nowiki></pre>
  
==== Wait for tarball build ====
 
* Wait for the $PROJECT-tarball job run to generate a $PROJECT-$PUBVERSION.tar.gz
 
  
==== Similarity check ====
+
'''Check bugs'''
* Check that this tarball is equivalent to the latest published $PROJECT-milestone-proposed.tar.gz
+
* Look at the list of FixCommitted bugs, sanity-check that they were fixed during the period
 +
 
 +
 
 +
==== RC1 tag ====
 +
 
 +
'''Get PTL signoff'''
 +
* Get RC1 $RCSHA from PTL
 +
* Check that the $MILESTONE changelog was committed to master
 +
 
 +
 
 +
'''Deferring blueprints'''
 +
* Move all incomplete blueprints to the next milestone ($MILESTONE should all be 'Implemented')
 +
* Move all incomplete bugs to the next milestone ($MILESTONE should all be 'Fix Committed')
  
==== Upload milestone ====
+
 
 +
'''Tag RC1, wait for tarball build and process FixCommitted bugs'''
 
<pre><nowiki>
 
<pre><nowiki>
./upload_release.py $PROJECT $VERSION --milestone=$MILESTONE
+
./swiftrc.sh $RC1SHA $MILESTONE
# For swift: ./upload_release.py swift $VERSION
 
 
</nowiki></pre>
 
</nowiki></pre>
  
==== Announce milestone ====
+
 
 +
'''Announce candidate builds'''
 
* Email to openstack general ML
 
* Email to openstack general ML
 
* Twitter
 
* Twitter
  
=== Post-milestone ===
 
  
==== Remove milestone-proposed branches ====
+
==== Further RCs ====
* In review.openstack.org project branch admin panel
+
 
 +
We generally hope that intermediary Swift releases won't generate multiple RCs, but shit sometimes happens. In that case we follow a manual process.
 +
 
 +
 
 +
'''Set up proposed/$MILESTONE branch'''
 +
* Go to review.openstack.org and create a proposed/$MILESTONE branch with the same SHA as the RC1 tag
 +
* Backport fixes to this branch
 +
 
 +
 
 +
'''Manually push new tag on that branch'''
 +
<pre><nowiki>
 +
git checkout master && git pull
 +
git checkout -b proposed/$MILESTONE -t origin/proposed/$MILESTONE
 +
git tag -m "Swift $MILESTONE-rc2" -s "${MILESTONE}rc2" $RC2SHA
 +
git push gerrit ${MILESTONE}rc2
 +
</nowiki></pre>
 +
 
 +
 
 +
==== Release ====
 +
 
 +
'''Get PTL signoff'''
 +
* Get confirmation that SHA=RCxSHA
 +
 
 +
 
 +
'''Tag, wait for tarball build, check similarities and upload'''
 +
<pre><nowiki>
 +
./milestone.sh $MILESTONE $SHA swift
 +
</nowiki></pre>
 +
 
 +
 
 +
'''Announce release'''
 +
* Email to openstack general ML & openstack announce.
 +
* Twitter
 +
* If a proposed/$MILESTONE branch was created, check that tags merged back to master and delete the branch (manually under review.openstack.org)
 +
 
  
 +
== Final release ==
  
= Final release =
+
NB: The rccut.sh and rcdelivery.sh scripts special-case swift (where RC milestones are named differently) and oslo-incubator (where no tarball is published), so you can just run the same commands with them. They do '''not''' handle oslo.* libraries where tagging is external: bugs must be closed directly and stable branches created manually.
  
(also works for Swift integrated releases)
 
 
<pre><nowiki>
 
<pre><nowiki>
PROJECT=nova       # or PROJECT=swift
+
PROJECT=nova
VERSION=2013.1    # or VERSION=1.8.0
+
SERIES=icehouse
NEXTVERSION=2013.2 # or NEXTVERSION=1.8.1
+
FINALSWIFT=2.0.0
NAME=grizzly      # or NAME=1.8.0
+
NEXTSERIES=juno
SERIES=grizzly
 
NEXTSERIES=havana
 
 
</nowiki></pre>
 
</nowiki></pre>
  
=== Pre-flight checks ===
 
  
==== Create next series ====
+
==== Pre-flight checks ====
 +
 
 +
'''Create next series'''
 
* Create $NEXTSERIES series in Launchpad
 
* Create $NEXTSERIES series in Launchpad
 
* Set status to Future, Set release manager
 
* Set status to Future, Set release manager
  
==== Missing files check ====
+
 
 +
'''Check RC1 has 'RC1' as short name'''
 +
* $NAME-rc1 should have 'RC1' as short milestone name
 +
 
 +
 
 +
'''Missing files check'''
 
<pre><nowiki>
 
<pre><nowiki>
 
./repo_tarball_diff.sh $PROJECT master
 
./repo_tarball_diff.sh $PROJECT master
 
</nowiki></pre>
 
</nowiki></pre>
  
==== Tarball/version status ====
 
* Check that the $PROJECT-[branch-]tarball jenkins jobs work properly and that they produce the right version numbers
 
  
==== Check bugs ====
+
'''Check bugs'''
 
* Look at the list of FixCommitted bugs, sanity-check that they were fixed during the period
 
* Look at the list of FixCommitted bugs, sanity-check that they were fixed during the period
  
=== MP cut (switch master to next version) ===
 
  
==== Get PTL signoff ====
+
'''Check for translations /requirements updates'''
 +
* Branch should have a relatively recent translation update
 +
* Branch should have a relatively recent requirements update
 +
 
 +
 
 +
==== stable/$SERIES branch cut (switch master to next version) ====
 +
 
 +
'''Get PTL signoff'''
 
* This should be done close to the RC1 cut
 
* This should be done close to the RC1 cut
* For Swift, check that the $VERSION changelog was committed to master
+
* For Swift, check that the $FINALSWIFT changelog was committed to master
* Note down MP cut commit id
 
  
==== Push new version to master ====
+
 
* Prepare change which sets next version on master branch in setup.py (or in swift/__init__.py)
+
'''Push new version to master'''
 +
* Prepare change which sets next version on master branch in setup.cfg (except for Swift which doesn't set preversions)
 
* Get it approved by core and make sure it's merged
 
* Get it approved by core and make sure it's merged
 +
* Note down SHA = stable/$SERIES cut commit id (the commit just before the version bump)
  
==== Create MP branch from previous commit ====
 
* Use review.openstack.org admin panel to create branch
 
* Branch name is "milestone-proposed", initial revision is the MP cut commit id
 
  
==== Process FixCommitted bugs ====
+
'''Create stable/$SERIES branch from previous commit, wait for tarball, process FixCommitted bugs'''
 
<pre><nowiki>
 
<pre><nowiki>
./process_bugs.py $PROJECT --settarget=$NAME-rc1 --fixrelease
+
./rccut.sh $SHA $SERIES $PROJECT [$FINALSWIFT]
 
</nowiki></pre>
 
</nowiki></pre>
  
==== Set $NEXTSERIES as active development ====
 
* Set $NEXTSERIES as the release udner development
 
  
=== RC1 cut ===
+
'''Set $NEXTSERIES as active development'''
 +
* Make $NEXTSERIES the "Development focus" for $PROJECT
 +
* Set $NEXTSERIES status to "Active development"
 +
* Set $SERIES status to "Pre-release freeze"
 +
 
  
==== Get PTL signoff ====
+
==== RC1 cut ====
* Check that the branch contents are ready to go from PTL perspective
 
  
==== Push rc1 tag to MP ====
+
'''Get PTL signoff'''
<pre><nowiki>
+
* Check that the branch contents are ready to go from PTL perspective (backport any last-minute bugfix)
git checkout -t -b milestone-proposed origin/milestone-proposed
 
git pull
 
git tag -s $VERSION.rc1
 
git push --tags gerrit
 
</nowiki></pre>
 
  
==== Wait for tarball build ====
 
* Wait for the $PROJECT-tarball job run to generate a $PROJECT-$VERSION.rc1.tar.gz
 
  
==== Upload release ====
+
'''Tag, wait for tarball, check similarities and upload'''
 
<pre><nowiki>
 
<pre><nowiki>
./upload_release.py $PROJECT $VERSION --milestone=$NAME-rc1
+
./rcdelivery.sh $SERIES rc1 $PROJECT [$FINALSWIFT]
 
</nowiki></pre>
 
</nowiki></pre>
  
==== Announce RC1 ====
+
 
 +
'''Announce RC1'''
 
* Email to openstack general ML
 
* Email to openstack general ML
 
* Twitter
 
* Twitter
  
=== Further RC-X windows ===
 
  
==== Decision to open next RC window ====
+
'''Unfreeze requirements'''
 +
* (should be doublechecked since we changed things here)
 +
* Create stable/$SERIES for openstack/requirements
 +
* Consider master branch unfrozen
 +
* Email to openstack dev ML
 +
 
 +
 
 +
==== Further RC-X windows ====
 +
 
 +
'''Decision to open next RC window'''
 
* Consider $SERIES-rc-potential bugs and discuss with PTL if they warrant a respin
 
* Consider $SERIES-rc-potential bugs and discuss with PTL if they warrant a respin
  
==== Create RC-X milestone page ====
+
 
* Create the RC-X milestone page on Launchpad
+
'''Create RC-X milestone page'''
 +
* Create the RC-X milestone page (short name = RCX) on Launchpad
 
* Target relevant bugs
 
* Target relevant bugs
  
====  Refine/fix bugs ====
+
 
 +
'''Refine/fix bugs'''
 
* Track bug fixes
 
* Track bug fixes
 
* Facilitate backports
 
* Facilitate backports
  
==== Get PTL signoff ====
+
 
 +
'''Check for translations/requirements updates'''
 +
* Branch should have a relatively recent translation update. This requires a manual script to be run.
 +
* Requirements job (as proposed automatically when stable/* is created) should be merged if it exists
 +
 
 +
 
 +
'''Get PTL signoff'''
 
* Get confirmation that RC is releasable from PTL perspective
 
* Get confirmation that RC is releasable from PTL perspective
  
==== Push M-rcX tag to MP ====
 
<pre><nowiki>
 
git checkout milestone-proposed
 
git pull
 
git tag -s $VERSION.rcX
 
git push --tags gerrit
 
</nowiki></pre>
 
  
==== Upload release ====
+
'''Tag, wait for tarball, check similarities and upload'''
 
<pre><nowiki>
 
<pre><nowiki>
./upload_release.py $PROJECT $VERSION --milestone=$NAME-rcX
+
./rcdelivery.sh $SERIES rcX $PROJECT [$FINALSWIFT]
 
</nowiki></pre>
 
</nowiki></pre>
  
==== Wait for tarball build ====
 
* Wait for the $PROJECT-tarball job run to generate a $PROJECT-$VERSION.rcX.tar.gz
 
  
==== Similarity check ====
+
'''Announce RC-X'''
* Check that this tarball is equivalent to the latest published $PROJECT-milestone-proposed.tar.gz
 
 
 
==== Announce RC-X ====
 
 
* Email to openstack general ML
 
* Email to openstack general ML
 
* Twitter
 
* Twitter
  
=== Final release ===
 
  
==== Create final release milestone page ====
+
==== Final release ====
 +
 
 +
'''Create final release milestone page'''
 
* Create the $VERSION final milestone page on Launchpad
 
* Create the $VERSION final milestone page on Launchpad
  
==== Push all bugs and blueprints to final page ====
+
 
 +
'''Push all bugs and blueprints to final page'''
 
<pre><nowiki>
 
<pre><nowiki>
 
./consolidate_release_page.py $PROJECT $SERIES $VERSION
 
./consolidate_release_page.py $PROJECT $SERIES $VERSION
 
</nowiki></pre>
 
</nowiki></pre>
 +
This can take a very long time. For large bugs you will have to run it multiple times. Verify all intermediary milestone pages are now empty.
  
This can take a very long time. For large bugs you will have to run it multiple times. Verify all intermediary milestone pages are now empty.
 
  
==== Push final version tag to MP ====
+
'''Tag, wait for tarball, check similarities and upload'''
 
<pre><nowiki>
 
<pre><nowiki>
git checkout milestone-proposed
+
./rcdelivery.sh $SERIES final $PROJECT [$FINALSWIFT]
git pull
 
git tag -s $VERSION
 
git push --tags gerrit
 
 
</nowiki></pre>
 
</nowiki></pre>
  
==== Wait for tarball build ====
 
* Wait for the $PROJECT-tarball job run to generate a $PROJECT-$VERSION.tar.gz
 
  
==== Similarity check ====
+
'''Extra similarity check'''
* Check that this tarball is equivalent to the latest published $PROJECT-$VERSION.rcX.tar.gz
 
 
 
==== Publish release ====
 
 
<pre><nowiki>
 
<pre><nowiki>
./upload_release.py $PROJECT $VERSION
+
./similar_tarballs.sh $PROJECT $VERSION.rcX $VERSION
 
</nowiki></pre>
 
</nowiki></pre>
  
==== Add release notes link to release page ====
+
 
 +
'''Add release notes link to release page'''
 
* Add the "See http://wiki.openstack.org/ReleaseNotes/$SERIES" note to the Release note on the download page.
 
* Add the "See http://wiki.openstack.org/ReleaseNotes/$SERIES" note to the Release note on the download page.
  
==== Announce release ====
+
 
 +
'''Announce release'''
 
* openstack-announce, openstack general ML
 
* openstack-announce, openstack general ML
 
* Twitter etc.
 
* Twitter etc.
  
=== Post-release ===
 
  
==== Update "Releases" wiki page ====
+
==== Post-release ====
 +
 
 +
'''Update wiki pages'''
 
* http://wiki.openstack.org/Releases
 
* http://wiki.openstack.org/Releases
 +
* https://wiki.openstack.org/wiki/Getting_The_Code
 +
 +
 +
'''Create openstack/openstack stable branch'''
 +
* This needs to be done before any stable branch is created
 +
* Go to review.openstack.org openstack/openstack branch admin panel
 +
* New branch: "stable/$SERIES", Initial revision: "HEAD"
 +
* Push update to .gitmodules switching all "." to "stable/$SERIES"
 +
  
==== Switch dev focus ====
+
'''Switch dev focus'''
* Switch dev focus to $NEXTSERIES and $NEXTSERIES status to under active development
 
 
* Switch $SERIES to current stable release, set release manager = openstack-stable-maint
 
* Switch $SERIES to current stable release, set release manager = openstack-stable-maint
 
* Switch previous stable release (series - 1) to Obsolete
 
* Switch previous stable release (series - 1) to Obsolete
  
==== Clean rc-potential tags ====
+
 
 +
'''Clean rc-potential tags'''
 
* Search for https://bugs.launchpad.net/openstack/+bugs?field.tag=$SERIES-rc-potential
 
* Search for https://bugs.launchpad.net/openstack/+bugs?field.tag=$SERIES-rc-potential
 
* Remove tag where found
 
* Remove tag where found
  
==== Create stable/$SERIES ====
 
  
This step is not necessary for Swift.
+
'''Enable stable/$SERIES'''
 +
* (should be doublechecked since we changed things here)
 +
* Add stable/$SERIES periodic jobs, example for Icehouse https://review.openstack.org/115933
  
Create devnull branch (from MP):
 
* Go to review.openstack.org project branch admin panel
 
* New branch: "devnull", Initial revision: "milestone-proposed"
 
  
 
+
'''Push .1 version to stable/$SERIES branch'''
Push .1 version to devnull branch:
 
 
<pre><nowiki>
 
<pre><nowiki>
git checkout -t -b devnull origin/devnull
+
git checkout -t -b stable/$SERIES origin/stable/$SERIES
vi setup.py # set to $VERSION.1
+
git checkout -b stable-$SERIES
 +
vi setup.cfg # set to $VERSION.1
 +
vi .gitreview # set defaultbranch=stable/$SERIES
 
git commit -a
 
git commit -a
git review devnull
+
git review stable/$SERIES
 
</nowiki></pre>
 
</nowiki></pre>
  
 
+
NB: For Swift, it still makes sense to commit the the defaultbranch patch (even if you don't do the setup.cfg version bump)
Create stable/$SERIES branch from devnull branch:
 
* Go to review.openstack.org project branch admin panel
 
* New branch: "stable/$SERIES", Initial revision: "devnull"
 
 
 
 
 
Remove devnull and milestone-proposed branches:
 
* In review.openstack.org project branch admin panel
 

Latest revision as of 16:11, 13 June 2016

Caution icon.svg {{{header}}}

{{{body}}}

You can find all tools mentioned here in the openstack-infra/release-tools repository.

Development milestone publication

PROJECT=nova
MILESTONE=juno-3


Pre-flight checks

Missing files check (for all integrated projects doing the milestone)

./repo_tarball_diff.sh $PROJECT master


Milestone tag/publication (between Tuesday and Thursday)

All the integrated projects, as well as oslo-incubator and oslo.messaging, need to follow this process sometimes during the milestone publication window.

NB: The milestone.sh script special-cases oslo-incubator (where no tarball is published) and oslo.messaging (where no tag is pushed and no tarball is published) so you can just run the same commands with them.


Get PTL signoff (for all except oslo.messaging)

  • PTL confirms SHA for tag


Deferring blueprints and bugs

  • Move all incomplete blueprints to the next milestone ($MILESTONE should all be 'Implemented')
  • Move all incomplete bugs to the next milestone ($MILESTONE should all be 'Fix Committed'). You can use the following script:
./process_bugs.py $PROJECT --milestone $MILESTONE --settarget $NEXTMILESTONE


Tag, wait for tarball build, process FixCommitted bugs, check similarities and upload (if applicable)

./milestone.sh $MILESTONE $SHA $PROJECT


NB: for oslo.messaging $SHA is not used for tagging and is therefore ignored.


When all projects are done

Announce milestone

  • Email to openstack general ML
  • Twitter


Swift intermediary releases

PROJECT=swift
MILESTONE=1.8.1


Pre-flight checks

Missing files check

./repo_tarball_diff.sh swift master


Check bugs

  • Look at the list of FixCommitted bugs, sanity-check that they were fixed during the period


RC1 tag

Get PTL signoff

  • Get RC1 $RCSHA from PTL
  • Check that the $MILESTONE changelog was committed to master


Deferring blueprints

  • Move all incomplete blueprints to the next milestone ($MILESTONE should all be 'Implemented')
  • Move all incomplete bugs to the next milestone ($MILESTONE should all be 'Fix Committed')


Tag RC1, wait for tarball build and process FixCommitted bugs

./swiftrc.sh $RC1SHA $MILESTONE


Announce candidate builds

  • Email to openstack general ML
  • Twitter


Further RCs

We generally hope that intermediary Swift releases won't generate multiple RCs, but shit sometimes happens. In that case we follow a manual process.


Set up proposed/$MILESTONE branch

  • Go to review.openstack.org and create a proposed/$MILESTONE branch with the same SHA as the RC1 tag
  • Backport fixes to this branch


Manually push new tag on that branch

git checkout master && git pull
git checkout -b proposed/$MILESTONE -t origin/proposed/$MILESTONE
git tag -m "Swift $MILESTONE-rc2" -s "${MILESTONE}rc2" $RC2SHA
git push gerrit ${MILESTONE}rc2


Release

Get PTL signoff

  • Get confirmation that SHA=RCxSHA


Tag, wait for tarball build, check similarities and upload

./milestone.sh $MILESTONE $SHA swift


Announce release

  • Email to openstack general ML & openstack announce.
  • Twitter
  • If a proposed/$MILESTONE branch was created, check that tags merged back to master and delete the branch (manually under review.openstack.org)


Final release

NB: The rccut.sh and rcdelivery.sh scripts special-case swift (where RC milestones are named differently) and oslo-incubator (where no tarball is published), so you can just run the same commands with them. They do not handle oslo.* libraries where tagging is external: bugs must be closed directly and stable branches created manually.

PROJECT=nova
SERIES=icehouse
FINALSWIFT=2.0.0
NEXTSERIES=juno


Pre-flight checks

Create next series

  • Create $NEXTSERIES series in Launchpad
  • Set status to Future, Set release manager


Check RC1 has 'RC1' as short name

  • $NAME-rc1 should have 'RC1' as short milestone name


Missing files check

./repo_tarball_diff.sh $PROJECT master


Check bugs

  • Look at the list of FixCommitted bugs, sanity-check that they were fixed during the period


Check for translations /requirements updates

  • Branch should have a relatively recent translation update
  • Branch should have a relatively recent requirements update


stable/$SERIES branch cut (switch master to next version)

Get PTL signoff

  • This should be done close to the RC1 cut
  • For Swift, check that the $FINALSWIFT changelog was committed to master


Push new version to master

  • Prepare change which sets next version on master branch in setup.cfg (except for Swift which doesn't set preversions)
  • Get it approved by core and make sure it's merged
  • Note down SHA = stable/$SERIES cut commit id (the commit just before the version bump)


Create stable/$SERIES branch from previous commit, wait for tarball, process FixCommitted bugs

./rccut.sh $SHA $SERIES $PROJECT [$FINALSWIFT]


Set $NEXTSERIES as active development

  • Make $NEXTSERIES the "Development focus" for $PROJECT
  • Set $NEXTSERIES status to "Active development"
  • Set $SERIES status to "Pre-release freeze"


RC1 cut

Get PTL signoff

  • Check that the branch contents are ready to go from PTL perspective (backport any last-minute bugfix)


Tag, wait for tarball, check similarities and upload

./rcdelivery.sh $SERIES rc1 $PROJECT [$FINALSWIFT]


Announce RC1

  • Email to openstack general ML
  • Twitter


Unfreeze requirements

  • (should be doublechecked since we changed things here)
  • Create stable/$SERIES for openstack/requirements
  • Consider master branch unfrozen
  • Email to openstack dev ML


Further RC-X windows

Decision to open next RC window

  • Consider $SERIES-rc-potential bugs and discuss with PTL if they warrant a respin


Create RC-X milestone page

  • Create the RC-X milestone page (short name = RCX) on Launchpad
  • Target relevant bugs


Refine/fix bugs

  • Track bug fixes
  • Facilitate backports


Check for translations/requirements updates

  • Branch should have a relatively recent translation update. This requires a manual script to be run.
  • Requirements job (as proposed automatically when stable/* is created) should be merged if it exists


Get PTL signoff

  • Get confirmation that RC is releasable from PTL perspective


Tag, wait for tarball, check similarities and upload

./rcdelivery.sh $SERIES rcX $PROJECT [$FINALSWIFT]


Announce RC-X

  • Email to openstack general ML
  • Twitter


Final release

Create final release milestone page

  • Create the $VERSION final milestone page on Launchpad


Push all bugs and blueprints to final page

./consolidate_release_page.py $PROJECT $SERIES $VERSION

This can take a very long time. For large bugs you will have to run it multiple times. Verify all intermediary milestone pages are now empty.


Tag, wait for tarball, check similarities and upload

./rcdelivery.sh $SERIES final $PROJECT [$FINALSWIFT]


Extra similarity check

./similar_tarballs.sh $PROJECT $VERSION.rcX $VERSION


Add release notes link to release page


Announce release

  • openstack-announce, openstack general ML
  • Twitter etc.


Post-release

Update wiki pages


Create openstack/openstack stable branch

  • This needs to be done before any stable branch is created
  • Go to review.openstack.org openstack/openstack branch admin panel
  • New branch: "stable/$SERIES", Initial revision: "HEAD"
  • Push update to .gitmodules switching all "." to "stable/$SERIES"


Switch dev focus

  • Switch $SERIES to current stable release, set release manager = openstack-stable-maint
  • Switch previous stable release (series - 1) to Obsolete


Clean rc-potential tags


Enable stable/$SERIES


Push .1 version to stable/$SERIES branch

git checkout -t -b stable/$SERIES origin/stable/$SERIES
git checkout -b stable-$SERIES
vi setup.cfg # set to $VERSION.1
vi .gitreview # set defaultbranch=stable/$SERIES
git commit -a
git review stable/$SERIES

NB: For Swift, it still makes sense to commit the the defaultbranch patch (even if you don't do the setup.cfg version bump)