Releasing janis is straight forward. Decide on a logical set of changes to include, this will
Janis follows the
SemVer versioning system:
- MAJOR version when you make incompatible API changes,
- MINOR version when you add functionality in a backwards-compatible manner, and
- PATCH version when you make backwards-compatible bug fixes.
Before a new release, you should update the version tag in
janis/__init__.py so the produced python package is
Tagging and Building¶
Before you tag, make sure you’ve incremented the
__version__flag per the previous section.
You can tag your commit for release by running the following bash command:
git commit -m "Tag for v0.x.x release" git tag -a "v0.x.x" -m "Tag message" git push origin v0.x.x
The final statement will push the tag to Github, where Travis will automatically pick up commit, build and deploy.
Github release notes¶
You should update the release notes in the
CHANGELOG.md where you’ll need to create a
## section with three bits of information:
- Release commit hash (eg:
- Github link to commits comparison:
$newis your old, and release commit hash respectively.
- Release notes: a summary of changes since the last release