aboutsummaryrefslogtreecommitdiffstats
path: root/docs/maintainer-guide.rst
blob: 7848265a6dca988f400f3410550cda405f7049f7 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
.. _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, e.g.::

    version=1.1.0

  Release candidates should take the form ``1.2.3rc4``.

- ``git tag -s $version``

- ``tox -e sdist``

- ``twine upload .tox/dist/git-deps-$version.zip``

- 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.