Skip to content

Commit 1de23ab

Browse files
committed
Start of admin tools for release
1 parent 6926b7c commit 1de23ab

File tree

1 file changed

+32
-2
lines changed

1 file changed

+32
-2
lines changed

CONTRIBUTING.rst

Lines changed: 32 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -191,5 +191,35 @@ However, JPEG images up to 2MiB are accepted.
191191
Performing a release
192192
--------------------
193193

194-
There is currently no release process.
195-
See `this issue <https://github.com/adamtheturtle/vws-python-mock/issues/12>`__ for details.
194+
Outcomes
195+
~~~~~~~~
196+
197+
* A new ``git`` tag available to install.
198+
199+
Prerequisites
200+
~~~~~~~~~~~~~
201+
202+
* ``python3`` on your ``PATH`` set to Python 3.5+.
203+
* ``virtualenv``.
204+
* Push access to this repository.
205+
* Trust that ``master`` is ready and high enough quality for release.
206+
207+
Perform a Release
208+
~~~~~~~~~~~~~~~~~
209+
210+
#. Get a GitHub access token:
211+
212+
Follow the `GitHub instructions <https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/>`__ for getting an access token.
213+
214+
#. Set environment variables to GitHub credentials, e.g.:
215+
216+
.. code:: sh
217+
218+
export GITHUB_TOKEN=75c72ad718d9c346c13d30ce762f121647b502414
219+
export GITHUB_OWNER=adamtheturtle
220+
221+
#. Perform a release:
222+
223+
.. code:: sh
224+
225+
curl https://raw.githubusercontent.com/"$GITHUB_OWNER"/vws-python-mock/master/admin/release.sh | bash

0 commit comments

Comments
 (0)