Merge pull request #871 from adamtheturtle/release-process

Release process

Author: adamtheturtle

CHANGELOG.rst

@@ -0,0 +1,7 @@
+Changelog
+=========
+
+.. contents::
+
+Next
+----

CONTRIBUTING.rst

@@ -74,5 +74,4 @@ The configuration for this is in ``.travis.yml``.
 Performing a release
 --------------------
 
-There is currently no release process.
-See `this issue <https://github.com/adamtheturtle/vws-python/issues/55>`__ for details.
+See release process in the full documentation.

admin/CHANGELOG.rst

@@ -0,0 +1,13 @@
+#!/usr/bin/env bash
+
+set -ex
+
+# Perform a release.
+# See the release process documentation for details.
+cd "$(mktemp -d)"
+git clone [email protected]:"${GITHUB_OWNER}"/vws-python.git
+cd vws-python-mock
+virtualenv -p python3 release
+source release/bin/activate
+pip install --editable .[dev]
+python admin/release.py

admin/release.sh

@@ -5,3 +5,4 @@ VWS Python
    :maxdepth: 3
 
    exceptions
+   release-process

docs/source/index.rst

@@ -0,0 +1,68 @@
+Release Process
+===============
+
+Outcomes
+~~~~~~~~
+
+* A new ``git`` tag available to install.
+* A new package on PyPI.
+
+Prerequisites
+~~~~~~~~~~~~~
+
+* ``python3`` on your ``PATH`` set to Python 3.6+.
+* ``virtualenv``.
+* Push access to this repository.
+* Trust that ``master`` is ready and high enough quality for release.
+
+Perform a Release
+~~~~~~~~~~~~~~~~~
+
+#. Install keyring
+
+   Make sure that `keyring <https://pypi.org/project/keyring/>`__ is available on your path.
+
+   E.g.:
+
+   .. code:: sh
+
+      curl https://raw.githubusercontent.com/mitsuhiko/pipsi/master/get-pipsi.py | python
+      pipsi install keyring
+
+#. Set up PyPI credentials
+
+Register at `PyPI <https://pypi.org>`__.
+
+Add the following information to :file:`~/.pypirc`.
+
+.. code:: ini
+
+   [distutils]
+    index-servers=
+        pypi
+
+    [pypi]
+    username = <Your PyPI username>
+
+Store your PyPI password:
+
+.. code:: sh
+
+   keyring set https://upload.pypi.org/legacy/ <Your PyPI username>
+
+#. Get a GitHub access token:
+
+   Follow the `GitHub instructions <https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/>`__ for getting an access token.
+
+#. Set environment variables to GitHub credentials, e.g.:
+
+    .. code:: sh
+
+       export GITHUB_TOKEN=75c72ad718d9c346c13d30ce762f121647b502414
+       export GITHUB_OWNER=adamtheturtle
+
+#. Perform a release:
+
+    .. code:: sh
+
+       curl https://raw.githubusercontent.com/"$GITHUB_OWNER"/vws-python/master/admin/release.sh | bash

docs/source/release-process.rst

@@ -9,6 +9,8 @@ ignore =
     .readthedocs.yml
     .style.yapf
     .travis.yml
+    admin
+    admin/release.sh
     CHANGELOG.rst
     CODE_OF_CONDUCT.rst
     CONTRIBUTING.rst
@@ -93,11 +95,13 @@ ignore_errors = True
 # Allow blank lines after function docstrings
 #   - D202
 # Section names do not need to end in newlines
-#	- D406
+#   - D406
 # Section names do not need dashed underlines
-# 	- D407
+#   - D407
 # No blank line is needed after the last section
-ignore = D200,D202,D203,D205,D212,D400,D406,D407,D413
+# Do not care about imperative mood
+#   - D401
+ignore = D200,D202,D203,D205,D212,D400,D406,D407,D413,D401
 match=(?!.*(versioneer|test_|_version)).*\.py
 
 [isort]

setup.cfg

@@ -92,6 +92,7 @@ def response(self) -> Response:
         """
         return self._response
 
+
 class TargetStatusProcessing(Exception):
     """
     Exception raised when Vuforia returns a response with a result code