Jump to: navigation, search

Difference between revisions of "ReleaseTeam/How To Release"

m
(Integrate Swift procedure)
Line 5: Line 5:
  
 
= Milestone publication =
 
= Milestone publication =
 +
 +
(also works for Swift interim releases)
  
 
<pre><nowiki>
 
<pre><nowiki>
PROJECT=nova
+
PROJECT=nova         # or PROJECT=swift
VERSION=2013.1
+
DEVVERSION=2013.1    # or DEVVERSION=1.8.1
MILESTONE=grizzly-3
+
MILESTONE=grizzly-3   # or MILESTONE=1.8.1
SHORT=g3
+
PUBVERSION=2013.1.g3 # or PUBVERSION=1.8.1
 
</nowiki></pre>
 
</nowiki></pre>
  
Line 27: Line 29:
  
 
==== Get PTL signoff ====
 
==== Get PTL signoff ====
 +
* For Swift, check that the $DEVVERSION changelog was committed to master
 +
* 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
 
* Note down MP cut commit id
  
Line 58: Line 62:
  
 
==== Get PTL signoff ====
 
==== 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
 
* Note down milestone cut commit id
  
Line 66: Line 71:
 
git checkout -t -b milestone-proposed origin/milestone-proposed
 
git checkout -t -b milestone-proposed origin/milestone-proposed
 
git pull
 
git pull
git tag -s "$PROJECT.$SHORT"
+
git tag -s "$PUBVERSION"
 
git push --tags gerrit
 
git push --tags gerrit
 
</nowiki></pre>
 
</nowiki></pre>
  
 
==== Wait for tarball build ====
 
==== Wait for tarball build ====
* Wait for the $PROJECT-tarball job run to generate a $PROJECT-$VERSION.$SHORT.tar.gz
+
* Wait for the $PROJECT-tarball job run to generate a $PROJECT-$PUBVERSION.tar.gz
 +
 
 +
==== Similarity check ====
 +
* Check that this tarball is equivalent to the latest published $PROJECT-milestone-proposed.tar.gz
  
 
==== Upload milestone ====
 
==== Upload milestone ====
 
<pre><nowiki>
 
<pre><nowiki>
 
./upload_release.py $PROJECT $VERSION --milestone=$MILESTONE
 
./upload_release.py $PROJECT $VERSION --milestone=$MILESTONE
 +
# For swift: ./upload_release.py swift $VERSION
 
</nowiki></pre>
 
</nowiki></pre>
  
Line 90: Line 99:
 
= Final release =
 
= Final release =
  
 +
(also works for Swift integrated releases)
 
<pre><nowiki>
 
<pre><nowiki>
PROJECT=nova
+
PROJECT=nova       # or PROJECT=swift
VERSION=2013.1
+
VERSION=2013.1     # or VERSION=1.8.0
NEXTVERSION=2013.2
+
NEXTVERSION=2013.2 # or NEXTVERSION=1.8.1
 +
NAME=grizzly      # or NAME=1.8.0
 
SERIES=grizzly
 
SERIES=grizzly
 
NEXTSERIES=havana
 
NEXTSERIES=havana
Line 119: Line 130:
 
==== Get PTL signoff ====
 
==== 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
 
* Note down MP cut commit id
 
* Note down MP cut commit id
  
 
==== Push new version to master ====
 
==== Push new version to master ====
* Prepare change which sets next version on master branch (in setup.py)
+
* Prepare change which sets next version on master branch in setup.py (or in swift/__init__.py)
 
* Get it approved by core and make sure it's merged
 
* Get it approved by core and make sure it's merged
  
Line 131: Line 143:
 
==== Process FixCommitted bugs ====
 
==== Process FixCommitted bugs ====
 
<pre><nowiki>
 
<pre><nowiki>
./process_bugs.py $PROJECT --settarget=$SERIES-rc1 --fixrelease
+
./process_bugs.py $PROJECT --settarget=$NAME-rc1 --fixrelease
 
</nowiki></pre>
 
</nowiki></pre>
  
Line 152: Line 164:
 
==== Upload release ====
 
==== Upload release ====
 
<pre><nowiki>
 
<pre><nowiki>
./upload_release.py $PROJECT $VERSION --milestone=$SERIES-rc1
+
./upload_release.py $PROJECT $VERSION --milestone=$NAME-rc1
 
</nowiki></pre>
 
</nowiki></pre>
  
Line 185: Line 197:
 
==== Upload release ====
 
==== Upload release ====
 
<pre><nowiki>
 
<pre><nowiki>
./upload_release.py $PROJECT $VERSION --milestone=$SERIES-rcX
+
./upload_release.py $PROJECT $VERSION --milestone=$NAME-rcX
 
</nowiki></pre>
 
</nowiki></pre>
  
Line 222: Line 234:
  
 
==== Similarity check ====
 
==== Similarity check ====
* Check that this tarball is equivalent to the latest published $PROJECT-rcX.tar.gz
+
* Check that this tarball is equivalent to the latest published $PROJECT-$VERSION.rcX.tar.gz
  
 
==== Publish release ====
 
==== Publish release ====
Line 230: Line 242:
  
 
==== Add release notes link to release page ====
 
==== Add release notes link to release page ====
* Add the "See http://wiki.openstack.org/ReleaseNotes/Folsom" 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 ====
Line 250: Line 262:
 
* Remove tag where found
 
* Remove tag where found
  
==== Create devnull branch (from MP) ====
+
==== Create stable/$SERIES ====
 +
 
 +
This step is not necessary for Swift.
 +
 
 +
Create devnull branch (from MP):
 
* Go to review.openstack.org project branch admin panel
 
* Go to review.openstack.org project branch admin panel
 
* New branch: "devnull", Initial revision: "milestone-proposed"
 
* New branch: "devnull", Initial revision: "milestone-proposed"
  
==== Push .1 version to devnull branch ====
+
 
 +
Push .1 version to devnull branch:
 
<pre><nowiki>
 
<pre><nowiki>
 
git checkout -t -b devnull origin/devnull
 
git checkout -t -b devnull origin/devnull
Line 262: Line 279:
 
</nowiki></pre>
 
</nowiki></pre>
  
==== Create stable/$SERIES branch from devnull branch ====
+
 
 +
Create stable/$SERIES branch from devnull branch:
 
* Go to review.openstack.org project branch admin panel
 
* Go to review.openstack.org project branch admin panel
 
* New branch: "stable/$SERIES", Initial revision: "devnull"
 
* New branch: "stable/$SERIES", Initial revision: "devnull"
  
==== Remove devnull and milestone-proposed branches ====
 
* In review.openstack.org project branch admin panel
 
 
= Swift releases (outdated !) =
 
 
Swift uses separate versioning and does not use milestones. Let's suppose we are releasing 1.8.2 and next version is called 1.8.3.
 
 
=== Pre-flight checks ===
 
 
==== Missing files check ====
 
 
<pre><nowiki>
 
cd swift
 
tarball-repo-diff
 
</nowiki></pre>
 
 
 
==== Tarball/version status ====
 
* Check that the swift-tarball jenkins jobs work properly and that they produce the right version numbers
 
 
==== Check bugs & blueprints ====
 
* Look at the list of FixCommitted bugs, sanity-check that they were fixed during the period
 
* Check that the 1.8.2 milestone page is sane (all implemented blueprints)
 
 
==== Get PTL signoff ====
 
* Check that the 1.8.2 changelog was committed to master
 
* Note down MP cut commit id
 
 
=== MP cut ===
 
 
==== Push new version to master ====
 
* Prepare change which sets 1.8.3 on master branch
 
* Get it approved by swift-core and make sure it's merged
 
 
==== 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 ====
 
 
<pre><nowiki>
 
./process-fixcommitted-bugs.py swift --milestone 1.8.2 --settarget 1.8.2 --fixrelease
 
</nowiki></pre>
 
 
 
==== Wait for tarball build ====
 
* Wait for the swift-tarball job run
 
* Note down tarball version
 
 
=== QA for proposed release ===
 
 
==== Push FINAL=True commit to MP ====
 
* Prepare change which sets FINAL=True on milestone-proposed branch
 
* Approve and make sure it's merged
 
 
==== Get Final PTL signoff ====
 
* Note down release commit id
 
 
==== Wait for tarball build ====
 
* Wait for the swift-tarball job run
 
* Note down tarball version
 
 
=== Release publication ===
 
 
==== Push tag to MP ====
 
 
<pre><nowiki>
 
git checkout milestone-proposed
 
git pull
 
git tag -s 1.8.2
 
git push --tags gerrit
 
</nowiki></pre>
 
 
 
==== Upload milestone ====
 
 
<pre><nowiki>
 
upload_release.py swift 1.8.2
 
</nowiki></pre>
 
 
 
==== Announce release ====
 
* Email to openstack general, openstack-announce ML
 
* Twitter
 
 
=== Post-milestone ===
 
  
==== Remove milestone-proposed branch ====
+
Remove devnull and milestone-proposed branches:
 
* In review.openstack.org project branch admin panel
 
* In review.openstack.org project branch admin panel

Revision as of 14:19, 12 March 2013

Raw notes for release monkeys in case I end up under a bus.

All tools mentioned here can be grabbed from this github repo.

Milestone publication

(also works for Swift interim releases)

PROJECT=nova          # or PROJECT=swift
DEVVERSION=2013.1     # or DEVVERSION=1.8.1
MILESTONE=grizzly-3   # or MILESTONE=1.8.1
PUBVERSION=2013.1.g3  # or PUBVERSION=1.8.1

Pre-flight checks

Missing files check

./repo_tarball_diff.sh $PROJECT master

Tarball/version status

  • Check that the $PROJECT-[branch-]tarball jenkins jobs work properly and that they produce the right version numbers

Check bugs

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

Get PTL signoff

  • For Swift, check that the $DEVVERSION changelog was committed to master
  • 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

  • Move all incomplete blueprints to the next milestone
  • Move all non-milestone-critical bugs to the next milestone

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 (or HEAD)

Process FixCommitted bugs

./process_bugs.py $PROJECT --settarget=$MILESTONE --fixrelease

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)

  • Email to openstack general ML
  • Twitter

In the next days (Wednesday-Thursday)

Track milestone-critical fixes

  • Target milestone-critical fixes to $MILESTONE
  • Backport them to milestone-proposed (see how to do it)

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)

Push tag to MP

git checkout -t -b milestone-proposed origin/milestone-proposed
git pull
git tag -s "$PUBVERSION"
git push --tags gerrit

Wait for tarball build

  • Wait for the $PROJECT-tarball job run to generate a $PROJECT-$PUBVERSION.tar.gz

Similarity check

  • Check that this tarball is equivalent to the latest published $PROJECT-milestone-proposed.tar.gz

Upload milestone

./upload_release.py $PROJECT $VERSION --milestone=$MILESTONE
# For swift: ./upload_release.py swift $VERSION

Announce milestone

  • Email to openstack general ML
  • Twitter

Post-milestone

Remove milestone-proposed branches

  • In review.openstack.org project branch admin panel


Final release

(also works for Swift integrated releases)

PROJECT=nova       # or PROJECT=swift
VERSION=2013.1     # or VERSION=1.8.0
NEXTVERSION=2013.2 # or NEXTVERSION=1.8.1
NAME=grizzly       # or NAME=1.8.0
SERIES=grizzly
NEXTSERIES=havana

Pre-flight checks

Create next series

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

Missing files check

./repo_tarball_diff.sh $PROJECT master

Tarball/version status

  • Check that the $PROJECT-[branch-]tarball jenkins jobs work properly and that they produce the right version numbers

Check bugs

  • 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

  • This should be done close to the RC1 cut
  • For Swift, check that the $VERSION 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)
  • Get it approved by core and make sure it's merged

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

./process_bugs.py $PROJECT --settarget=$NAME-rc1 --fixrelease

RC1 cut

Get PTL signoff

  • Check that the branch contents are ready to go from PTL perspective

Push rc1 tag to MP

git checkout -t -b milestone-proposed origin/milestone-proposed
git pull
git tag -s $VERSION.rc1
git push --tags gerrit

Wait for tarball build

  • Wait for the $PROJECT-tarball job run to generate a $PROJECT-$VERSION.rc1.tar.gz

Upload release

./upload_release.py $PROJECT $VERSION --milestone=$NAME-rc1

Announce RC1

  • Email to openstack general ML
  • Twitter

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 on Launchpad
  • Target relevant bugs

Refine/fix bugs

  • Track bug fixes
  • Facilitate backports

Get PTL signoff

  • Get confirmation that RC is releasable from PTL perspective

Push M-rcX tag to MP

git checkout milestone-proposed
git pull
git tag -s $VERSION.rcX
git push --tags gerrit

Upload release

./upload_release.py $PROJECT $VERSION --milestone=$NAME-rcX

Wait for tarball build

  • Wait for the $PROJECT-tarball job run to generate a $PROJECT-$VERSION.rcX.tar.gz

Similarity check

  • Check that this tarball is equivalent to the latest published $PROJECT-milestone-proposed.tar.gz

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 nova morlock 2014.1

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

git checkout milestone-proposed
git pull
git tag -s $VERSION
git push --tags gerrit

Wait for tarball build

  • Wait for the $PROJECT-tarball job run to generate a $PROJECT-$VERSION.tar.gz

Similarity check

  • Check that this tarball is equivalent to the latest published $PROJECT-$VERSION.rcX.tar.gz

Publish release

./upload_release.py $PROJECT $VERSION

Add release notes link to release page

Announce release

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

Post-release

Update "Releases" wiki page

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 previous stable release (series - 1) to Obsolete

Clean rc-potential tags

Create stable/$SERIES

This step is not necessary for Swift.

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 devnull branch:

git checkout -t -b devnull origin/devnull
vi setup.py # set to $VERSION.1
git commit -a
git review devnull


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