diff options
Diffstat (limited to 'docs/maintainer-guide.rst')
| -rw-r--r-- | docs/maintainer-guide.rst | 44 |
1 files changed, 44 insertions, 0 deletions
diff --git a/docs/maintainer-guide.rst b/docs/maintainer-guide.rst new file mode 100644 index 0000000..2c3a611 --- /dev/null +++ b/docs/maintainer-guide.rst @@ -0,0 +1,44 @@ +.. _release: + +================== + Maintainer guide +================== + +This guide contains a playbook for tasks the maintainer will need to +perform. + + +Initial setup +============= + +- Create a PyPI account + +- Configure `~/.pypirc` with credentials + +- `pip install twine` + + +How to make a new release of git-deps +===================================== + +- Ensure everything is committed and the git working tree is clean. + +- Ensure all change have been pushed to the remote branch. + +- Run `tox` to check everything is OK. + +- Decide a new version. Release candidates should take the form + `1.2.3rc4`. + +- `git tag -s $version` + +- `tox -e sdist` + +- `twine dist/git-deps-$version.tar.gz` + +- Check the new version appears at `<https://pypi.org/project/git-deps/>`_. + +- Test installation via at least one of the documented options, e.g. + `pip install git-deps` within a virtualenv. + +- Test / update the Docker-based installation. |