Differences between revisions 2 and 12 (spanning 10 versions)
⇤ ← Revision 2 as of 2009-08-08 01:59:13 →
Size: 3690
Editor: jkakar
Comment: Many improvements
← Revision 12 as of 2010-08-05 23:02:57 → ⇥
Size: 4062
Editor: jkakar
Comment:
Deletions are marked like this. Additions are marked like this.
Line 1: Line 1:
`DRAFT - This is a work in progress`
Line 5: Line 3:

<<TableOfContents>>
Line 9: Line 9:
The ```python-storm``` package is made to be built with AutoPPA.
You need to create a ```~/.autoppa.conf``` file with contents
similar to:		 The `python-storm` package is made to be built with AutoPPA.
AutoPPA eases the process of building packages for all supported
releases of Ubuntu. You need to create a `~/.autoppa.conf` file
with contents similar to:
Line 17: Line 18:
branch = /home/username/src/projects/storm/trunk branch = /home/username/src/projects/storm/packaging
Line 19: Line 20:
releases = dapper hardy intrepid jaunty karmic releases = dapper hardy karmic lucid maverick
Line 22: Line 23:
You'll also need something similar to this in your ```~/.dput.cf```: The branch above should be a branch of `lp:~storm/storm/packaging`.
It's best to `bzr checkout` the branch, to ensure that changes are
uploaded back to the master copy. You'll also need something
similar to this in your `~/.dput.cf`:
Line 33: Line 37:
[[https://launchpad.net/autoppa|AutoPPA]] is available on Launchpad. [[https://launchpad.net/autoppa|AutoPPA]] is available from
Launchpad.
Line 38: Line 43:
Before you start make sure all bugs in the current active milestone
on Launchpad are in the ```Fix Committed``` state. It's also a good
idea to review the Bazaar log to make sure the NEWS file contains
information about all the important changes. When all the bug fixes
and new features are ready in		  1. Make sure all bugs in the current active milestone on Launchpad
 are in the `Fix Committed` state.

 1. Review the Bazaar log and make sure the NEWS file contains
 information about all the changes made since the last release.

When all the bug fixes and new features are ready in
Line 46: Line 53:
Make a ```version-0.15``` branch where you will implement and test
the modifications required to make the new release. Start by
editing the ```storm/__init__.py``` file and update the
```version``` attribute to use the new version number.		  1. Edit `storm/__init__.py` and set `version` to the new version.

 1. Merge the changes from `trunk` into the `packaging` branch.
Line 52: Line 58:
== Preparing release-candidate packages == == Preparing a release-candidate package ==
Line 54: Line 60:
Build the package in your own PPA so that you can test them before
publishing them.  Use the ```--no-merge``` option to build test
packages:

{{{
$ autoppa --no-merge storm-0.15-1~rc2
}}}

``FIXME`` Provide instructions explaining AutoPPA installation.		  1. Build the package in your own PPA so that you can test them
 before publishing them in the official Storm PPA:
 `autoppa build storm 0.18-1~rc1`
Line 65: Line 65:
specified in ```~/.autoppa.conf```. When the ```python-storm``
packages build you should test them in pristine environments, to
make sure they work properly. Amazon's EC2 is good for this kind of
testing. If you run into problems you can build the package locally
to debug issues:		 specified in `~/.autoppa.conf`. When the `python-storm` packages
build you should test them in pristine environments, to make sure
they work properly. Amazon's EC2 is good for this kind of testing.
If you run into problems you can build the package locally to debug
issues (run in the `packaging` branch): `fakeroot debian/rules binary`
Line 71: Line 71:
{{{
$ fakeroot debian/rules binary
}}}

Commit any changes needed to make the package work to the
```version-0.15``` branch.		 Any changes made for the build will have been committed to the
`packaging` branch.
Line 81: Line 77:
The ```release``` make target creates a tarball in the ```dist```
directory.		  1. Run `make release` to prepare a tarball (created in the `dist`
 directory).
Line 84: Line 80:
{{{
$ make release
}}}		  1. This will create `dist/storm-0.17.tar.bz2`. Unpack it and make
 sure everything is in place: the README, NEWS, TODO and LICENSE
 files, the PKG-INFO and other distutils setup files, the debian
 directory with package source, the storm and tests directories with
 Python code, the Makefile and the storm.egg-info directory.
Line 88: Line 86:
This will create ```dist/storm-0.15.tar.bz2```. Unpack it and make
sure everything is in place: the README, NEWS, TODO and LICENSE
files, the PKG-INFO and other distutils setup files, the debian
directory with package source, the storm and tests directories with
Python code, the Makefile and the storm.egg-info directory.
== Decide whether to move on ==

If everything looks good move onto the next step. Otherwise, fix
the problems and build a new version of the package. Bump the
`stormN` part of the version string to `stormN+1`.
Line 97: Line 96:
If the tarball and package are in order merge the branch to trunk.
Use your PPA to rebuild the package, using trunk as the source
branch, with the new release version:		 If the tarball and package are in order you can copy the package to
the official Storm PPA and upload the tarball to Launchpad.
Line 101: Line 99:
{{{
$ autoppa storm-0.15-1~storm1
}}}		  1. Find the new packages in your PPA and copy them to the Storm
 Team PPA to publish them.
Line 105: Line 102:
This will upload sources, like before, but it will also create a
branch with a revision storing the changes made for each release
that was built. This branch will be merged to trunk and a tag based
on the new version will be added to the new revision to track it.		  1. Upload the tarball to Launchpad using the 'Create a release'
 function from the milestone page. Let Launchpad close the
 milestone as part of creating the release.
Line 110: Line 106:
When the new packages have finished building find them in your PPA
and copy them to the Storm Team PPA to publish them. Upload the
tarball to Launchpad using the 'Create a release' function from the
milestone page. Write a nice release announcement for the Launchpad
page and send a copy of it to the Storm mailing list to announce the
release.		  1. After the release is created use the 'Add file' function to
 upload the tarball. Be sure to also upload a valid GPG signature
 for it.

 1. Write a nice release announcement for the Launchpad page and
 send a copy of it to the Storm mailing list to announce the
 release. See the Storm mailing list archive for examples of the
 announcement.


== Prepare to develop the next version ==

 1. If it hasn't already been done, create a milestone for the next
 version and target bugs that needs to be delivered with it.

 1. Bump the `version` value in the `storm/__init__.py`.

Preparing a release is a fairly straight-forward process despite appearances to the contrary.

Contents

  1. Setting up the tools
  2. Are you ready?
  3. Preparing a release-candidate package
  4. Preparing a release-candidate tarball
  5. Decide whether to move on
  6. Creating and publishing the new tarball and packages
  7. Prepare to develop the next version

Setting up the tools

The python-storm package is made to be built with AutoPPA. AutoPPA eases the process of building packages for all supported releases of Ubuntu. You need to create a ~/.autoppa.conf file with contents similar to: 

[storm]
email = Username <username@example.com>
ppa = username
branch = /home/username/src/projects/storm/packaging
repository = /home/username/src/autoppa-builds
releases = dapper hardy karmic lucid maverick

The branch above should be a branch of lp:~storm/storm/packaging. It's best to bzr checkout the branch, to ensure that changes are uploaded back to the master copy. You'll also need something similar to this in your ~/.dput.cf: 

[username]
fqdn = ppa.launchpad.net
method = ftp
incoming = ~username/ppa/ubuntu/
login = anonymous
allow_unsigned_uploads = 0

AutoPPA is available from Launchpad.

Are you ready?

  1. Make sure all bugs in the current active milestone on Launchpad

    are in the Fix Committed state.

  2. Review the Bazaar log and make sure the NEWS file contains information about all the changes made since the last release.

When all the bug fixes and new features are ready in trunk it's time to create the release.

  1. Edit storm/__init__.py and set version to the new version.

  2. Merge the changes from trunk into the packaging branch.

Preparing a release-candidate package

  1. Build the package in your own PPA so that you can test them before publishing them in the official Storm PPA:

    autoppa build storm 0.18-1~rc1

This will upload sources to your PPA for the Ubuntu releases specified in ~/.autoppa.conf. When the python-storm packages build you should test them in pristine environments, to make sure they work properly. Amazon's EC2 is good for this kind of testing. If you run into problems you can build the package locally to debug issues (run in the packaging branch): fakeroot debian/rules binary

Any changes made for the build will have been committed to the packaging branch.

Preparing a release-candidate tarball

  1. Run make release to prepare a tarball (created in the dist directory).

  2. This will create dist/storm-0.17.tar.bz2. Unpack it and make sure everything is in place: the README, NEWS, TODO and LICENSE files, the PKG-INFO and other distutils setup files, the debian directory with package source, the storm and tests directories with Python code, the Makefile and the storm.egg-info directory.

Decide whether to move on

If everything looks good move onto the next step. Otherwise, fix the problems and build a new version of the package. Bump the stormN part of the version string to stormN+1.

Creating and publishing the new tarball and packages

If the tarball and package are in order you can copy the package to the official Storm PPA and upload the tarball to Launchpad.

  1. Find the new packages in your PPA and copy them to the Storm Team PPA to publish them.
  2. Upload the tarball to Launchpad using the 'Create a release' function from the milestone page. Let Launchpad close the milestone as part of creating the release.
  3. After the release is created use the 'Add file' function to upload the tarball. Be sure to also upload a valid GPG signature for it.
  4. Write a nice release announcement for the Launchpad page and send a copy of it to the Storm mailing list to announce the release. See the Storm mailing list archive for examples of the announcement.

Prepare to develop the next version

  1. If it hasn't already been done, create a milestone for the next version and target bugs that needs to be delivered with it.

  2. Bump the version value in the storm/__init__.py.

ReleaseProcedure (last edited 2011-10-05 16:02:48 by barry)