GitLab

Release versioning convention:

• Major version update (1.0 -> 2.0) when including significantly new functionality, where changes are not compatible with previous versions
• Minor version update (1.0 -> 1.1) when adding new functionality that remain backwards compatible
• Patch version update (1.0 -> 1.0.1) when adding patches that remain backwards compatible

Steps required to make a new release

1. Create a new branch named release_vX.Y.Z from the master branch
2. Merge all changes into the release branch
3. Make sure all unit tests and doc tests are passing successfully on the GitLab server
4. Make sure all tutorials are working; if necessary update tutorials and copy new html files to the appropriate folder in the ketos docs section.
5. Update the change log (docs/source/versions/changelog.rst)
6. Update the version number in setup.py and docs/source/conf.py
7. Commit and push changes from step 4 and 5 to the release branch
8. Build the documentation:

cd docs/
make html

9. Review the documentation
10. Create a merge request for the release branch into the master branch (Note: Do not select Delete source branch)
11. Once this merge request has been reviewed and accepted, upload the new version to PyPI:

python setup.py sdist bdist_wheel
twine upload dist/ketos-X.Y.Z.tar.gz

12. Finally, upload the documentation to the docs server:

cd docs
./upload.sh