Development: Versions and Releases

Versions

We're using the bumpversion utility to manage version numbers in the python projects. Usually cutting a new release consists of increasing the version number then committing and tagging the change. Those steps are consolidated into a single command with bumpversion.

Use the following command to install bumpversion if you don't have it on your system yet:

pip install bumpversion

Execute the following in the repo root to update the version:

bumpversion patch  # (or 'minor' or 'major')

this will update setup.py and setup.cfg, commit the changes and created a tag. You can view the result with git log.

Releases

Releasing a new package to PyPI is automated through Travis CI. A new release is automatically uploaded whenever a new tagged commit is detected that passes all tests.

Therefore it is important to use the following command when pushing to Github to ensure tags are also uploaded:

git push && git push --tags

Note: When releasing new versions of base libraries (i.e. devp2p, rlp, ethereum) please remember to update the version in the requirements of the projects using those libraries.