Making a release of mazer

Overview

To release a new version of mazer, the steps are:

1. Bump the version
2. Build python packages
3. Upload new packages to PyPI

Update README.md, README.rst, and HISTORY.rst

The README's

README.md is the info shown when viewing the mazer github page.

README.rst is used when build python packages. The info in README.rst will used in the main project description at the PyPI mazer page (https://pypi.org/project/mazer)

HISTORY.rst is a change log that is also used for PyPI. It's contents will be appended to the README.rst.

Update README.md

Update to include examples of new features, etc. This does not need to include to itemized change log notes since that should be added to HISTORY.rst

Update README.rst and HISTORY.rst

To verify the format of the rst is valid, install the python package 'readme_renderer'.

'readme_renderer' will add a 'check' command to setup.py. To use:

python setup.py check -r -s

Bump the version

Mazer uses 'bumpversion' to update the mazer version and to create a git tag for the new version.

bumpversion

See https://github.com/peritus/bumpversion for bumpversion documentation.

If current version is '0.1.0', use 'bumpversion patch' or 'make dev/bumpversion-patch' to:

• Replace ansible_galaxy*/init.py version value with '0.1.1'
• Replace setup.py 'version' value with '0.1.1'
• Replace setup.cfg 'version' value with '0.1.1'
• commit those changes with the message "Bump version: 0.1.0 → 0.1.1"
• git tag as 'v0.1.1'

Build python packages

Build a sdist

python setup.py sdist

Build a wheel

python setup.py bdist_wheel --universal

Upload to PyPI

Using twine

Using version 0.1.0 as an example:

twine upload --username ansible "dist/mazer-0.1.0.tar.gz" "dist/mazer-0.1.0-py2.py3-none-any.whl"