How to release

Preparation

• Start a reminder issue a few days before the release (e.g. issue #29) Leave this issue open until the release is done and close it with a comment to inform the other developers.
• Test the examples and start in issue for non working examples.
• Keep an eye on open issues that are set to your release but seem to be forgotten.
• Make sure you have a pypi account with the rights to update oemof or ask somebody to upload the release for you.

Day of release

• Close "forgotten" issues with a recapitulatory comment or set them to a later release if they are still important.
• Set a release branch to avoid conflicts with other uses while the release progress.
• Run examples and tests
• Fix bugs if possible or remove merges/commits that causes the bugs from the release branch.
• Check the whatsnew-file and create a new one for the next release in the whatsnew-folder.
• Check if the latest documentation looks right at readthedocs. Start the compile process manually or it might take a time (could be obsolete now because github is now webhooked with rtd).
• Change the version number at VERSION and __init__py.
• If everything seems to work, merge the release branch into the master branch and the dev branch.
• Remove the obsolete release branch.
• Check whether Readme.rst and getting_started.rst are the same. They should only have different links.
• Set a release on github. Select the master branch (default: dev)! A label is set automatically.
• Use git fetch to see the label in your local master branch.
• Register the version at pypi. Using the command python setup.py register sdist upload. Make sure you checked out the master branch. (you will need a pypi account which is affiliated with the oemof group)
• (TO BE DISCUSSED: Build the doccumentation locally with sphinx-build -b html oemof/doc/ builddir and upload it at pypi., see https://github.com/oemof/oemof/issues/1#issuecomment-174558386)
• Start the building of the documentation on RTD for the new version and the stable version (could be obsolete now because github is now webhooked with rtd).
• Add a link in the whatsnew.rst file. Open the file locally or use the RAW button to see the links.
• Write a post in the wordpress blog.
• Close the release issue with informations for the community and relax (e.g. issue #29, issue #108).