Create a Release

This guide is more for internal purposes. It explains how to create a new saga-python release.

1. Prepare Source Files

• Update the version number in saga/VERSION
• If aplicable, change the trove category for Bliss's development status in setup.py. Possible values are:
  Development Status :: 1 - Planning
Development Status :: 2 - Pre-Alpha
Development Status :: 3 - Alpha
Development Status :: 4 - Beta
Development Status :: 5 - Production/Stable
Development Status :: 6 - Mature
Development Status :: 7 - Inactive
  

2. Update Changelog

• This is important: CHANGELOG should reflect all changes and improvements that have made it into the current release.

3. Check Buildbot Results

• Before we can tag the final release, we have to make sure that all continuous integration tests have passed.

4. Git Release Tag

• Based on / more info: http://gitready.com/beginner/2009/02/03/tagging.html

Creating a tag in git is pretty straight forward:

git tag -a vX.Y.Z -m "Tagging X.Y.Z release"
git push origin vX.Y.Z

The tag will become available on the website (including automatic tar.gz download): https://github.com/saga-project/bliss/tags

5. Generate and Update API Documentation

To generate the API documentation, run this in the Bliss root directory:

epydoc -v --no-frames --config=docs/epydoc.bliss.saga.cfg

Next, checkout the gh-pages, remove the old API documentation, and replace it with the new one:

git clone -b gh-pages [email protected]:saga-project/bliss.git /tmp/bliss-website
cd /tmp/bliss-website
rm -rf apidoc/*
git commit -a -m 'Removed old API documentation'
cp -r $BLISSROOT/docs/bliss.saga/* apidoc
git add apidoc/*
git commit -a -m 'Added new API documentation'
git push origin gh-pages

6. Cheese Shop (PyPi) Upload

• Based on / more info: http://wiki.python.org/moin/CheeseShopTutorial
  
• Also very helpful: http://www.youtube.com/watch?v=B3KBuQHHKx0

Uploading the new Bliss release to the PyPi Cheese Shop is really simple. Just run this command in the Air source root:

$ python setup.py sdist upload

It is also possible to log into PyPi and upload or change the Bliss package manually. The package lives here: http://pypi.python.org/pypi/bliss/

7. Spread the News

• 1. Release announcement on in the 'NEWS' section on the Wiki front-page: https://github.com/saga-project/bliss/wiki
• 2. Release announcement on the [email protected] and [email protected]mailing list
• 3. Release announcement on Twitter via @SAGAGridAPI.

8. Update Relevant Wiki Pages and Website

Especially, if new plug-ins have been released, several wiki pages should be updated:

• The wiki front page: https://github.com/saga-project/bliss/wiki
• The plug-in page: https://github.com/saga-project/bliss/wiki/Plugins
• The website (supported middleware):