HowToRelease

Some developer notes on how to do the release (magic numbers are for version 1.1):

1. Create a Release Notes page on the wiki (with some sensible content in it!) and modify History to link it.

2. Commit new version number (one change in setup.py, one in docs/conf.py):

   git commit -a
   

   with commit message like:

   Version 1.1.0
   
   https://github.com/cms-dev/cms/wiki/CMS-1.1.0-RELEASE-NOTES
   

3. Tag the commit:

   git tag v1.1.0
   

4. Create a branch for the version number:

   git checkout -b v1.1
   

5. Push branches and tag to the repository. Push also changes to the wiki.

6. Wait for the new branch (the branch, not the tag!) to pop up in ReadTheDocs control panel (it takes a bit for RTD to realize that a new branch has been pushed; I did not find any way to force it). Then activate it and make it default.

7. Check that relevant automatic links have been created by GitHub, so that there are no 404 errors around (in wiki and in docs). Also check that documentation have been compiled correctly.

8. Push the new version number for the stable and development version in the website (for the stable version update also the URLs of the links).

9. Send Release Notes to the mailing list (for reference: http://www.freelists.org/post/contestms/CMS-100-RELEASE-NOTES).

10. Go back to master and commit new version numbers (one change in setup.py, two changes in docs/conf.py).

11. Close the milestone on GitHub.