Release Checklist

Releasing a new package (whether part of Launchpad or not) involves many of the same steps each time.

[BAW: Note that in the fine tradition of PEP 101, you should debug these instructions each time you actually make a release.]

[BAW: Note that the instructions here are pretty specific to releasing Python packages. I think it will make more sense to separate this out based on language, since other languages will have their own way of doing things. I anticipate most of our releases being Python, so that's what I'm describing here.]

First steps

You will want to make sure your Python package is available on the Cheeseshop (a.k.a. Python Package Index or PyPI). You need to register yourself with PyPI so that you can upload packages. I thought you could do this from the command line, but I'm not able to find it. In the meantime:

• Go to http://pypi.python.org/pypi and register

First release only:

Follow CreatingNewProjects.

All releases (first and subsequent):

• Make sure your GPG key is publicly available.
• Bump the version number.

  • Python: this is probably in the setup.py or in package/init.py

  • Meditate upon http://semver.org/

• Update the NEWS.txt file.

  • Hopefully, you've been keeping this up-to-date as you've changed the package. If not, do a bzr log to figure out what's changed. Use the StandardNewsFile format.

• Tag your branch: bzr tag X.Y.Z (make sure this tag matches what's in your init.py or setup.py file).

• Build your package and upload it:

  • You will want to build one source distribution and one or more egg distributions. The eggs are Python version specific, you need to do the first command to get the tarball and first egg, and then the subsequent commands for every other Python version you want to support with an egg. I recommend Python 2.4, 2.5, and 2.6. [ctheune: Note that releasing eggs isn't necessary for platforms which regularly have compilers around. For Python-only packages any platform can run from the source distribution. Releasing binary eggs is error prone because of an incomplete discriminator anyway and is a usual source of confusion and avoidable errors.]

  • pythonX.Y setup.py sdist bdist_egg upload -s
  • pythonX.U setup.py bdist_egg upload -s
  • pythonX.Z setup.py bdist_egg upload -s
• Make sure the project's data in Launchpad is public! Check that you can browse the code branch(es), etc.
• Announce in appropriate places:

  • python-announce@python.org

  • Your Launchpad project's announce page
  • Any other appropriate place (but coordinate to avoid duplicate announcements).
  Ideally, someone who's active in the relevant community makes the announcement there. The announcements don't have to be in a standardized form, as long as they contain the important information and point back to the project's page. It's better each is written in that announcer's usual "voice", in fact, since the announcer is already known to that community.