Skip to content

Commit 4656892

Browse files
committed
Document release process
1 parent 8bc589b commit 4656892

File tree

3 files changed

+70
-2
lines changed

3 files changed

+70
-2
lines changed

CONTRIBUTING.rst

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -74,5 +74,4 @@ The configuration for this is in ``.travis.yml``.
7474
Performing a release
7575
--------------------
7676

77-
There is currently no release process.
78-
See `this issue <https://github.com/adamtheturtle/vws-python/issues/55>`__ for details.
77+
See release process in the full documentation.

docs/source/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,3 +5,4 @@ VWS Python
55
:maxdepth: 3
66

77
exceptions
8+
release-process

docs/source/release-process.rst

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
Release Process
2+
===============
3+
4+
Outcomes
5+
~~~~~~~~
6+
7+
* A new ``git`` tag available to install.
8+
* A new package on PyPI.
9+
10+
Prerequisites
11+
~~~~~~~~~~~~~
12+
13+
* ``python3`` on your ``PATH`` set to Python 3.6+.
14+
* ``virtualenv``.
15+
* Push access to this repository.
16+
* Trust that ``master`` is ready and high enough quality for release.
17+
18+
Perform a Release
19+
~~~~~~~~~~~~~~~~~
20+
21+
#. Install keyring
22+
23+
Make sure that `keyring <https://pypi.org/project/keyring/>`__ is available on your path.
24+
25+
E.g.:
26+
27+
.. code:: sh
28+
29+
curl https://raw.githubusercontent.com/mitsuhiko/pipsi/master/get-pipsi.py | python
30+
pipsi install keyring
31+
32+
#. Set up PyPI credentials
33+
34+
Register at `PyPI <https://pypi.org>`__.
35+
36+
Add the following information to :file:`~/.pypirc`.
37+
38+
.. code:: ini
39+
40+
[distutils]
41+
index-servers=
42+
pypi
43+
44+
[pypi]
45+
username = <Your PyPI username>
46+
47+
Store your PyPI password:
48+
49+
.. code:: sh
50+
51+
keyring set https://upload.pypi.org/legacy/ <Your PyPI username>
52+
53+
#. Get a GitHub access token:
54+
55+
Follow the `GitHub instructions <https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/>`__ for getting an access token.
56+
57+
#. Set environment variables to GitHub credentials, e.g.:
58+
59+
.. code:: sh
60+
61+
export GITHUB_TOKEN=75c72ad718d9c346c13d30ce762f121647b502414
62+
export GITHUB_OWNER=adamtheturtle
63+
64+
#. Perform a release:
65+
66+
.. code:: sh
67+
68+
curl https://raw.githubusercontent.com/"$GITHUB_OWNER"/vws-python/master/admin/release.sh | bash

0 commit comments

Comments
 (0)