Release Process¶
This page documents the steps to be taken to release a new version of Sphinx AutoAPI.
Pre-Checks¶
- Check that the dependencies of the package are correct.
- Clean the
.tox
directory and run the tests. - Commit and push any changes needed to make the tests pass.
- Check that the tests passed on travis and appveyor.
Preparation¶
- Update the version number in
setup.py
anddocs/conf.py
. - Add any missing changelog entries.
- Put the version number and release date into the changelog.
- Commit and push the changes.
- Check that the tests passed on travis and appveyor.
Release¶
git clean -fdx
python setup.py sdist bdist_wheel
twine upload dist/*