This document describes the deployment details to perform a version release.
The release cycle should be performed like this:
-
Increment the release numbers in the top-directory
setup.py
script:MAJOR MINOR MICRO
The complete tag is
VERSION = "v[MAJOR].[MINOR].[MICRO]"
. -
Set the variable
GIT_REVISION
to the latest commit in the top-directorysetup.py
. This means that the revision specification for the release actually corresponds to the commit just before the actual release. You can get the commit hash by:git rev-parse HEAD GIT_REVISION = <git rev-parse HEAD>
-
Commit changes:
git add setup.py git commit -m "Release [VERSION]"
with the corresponding version number.
-
Tag the commit with:
git tag -a "[VERSION]" -m "Releasing [VERSION]"
Include a complete description of the essential code modifications since last release.
-
Merge
master
branch intogh-pages
and updatehtml
documentation:git checkout gh-pages git merge master cd docs ./run.sh git add latest git commit -m "docs: update html"