Document how releases are built

1 files changed, 17 insertions, 0 deletions

diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst
index 2671c63..fdc1168 100644
--- a/CONTRIBUTING.rst
+++ b/CONTRIBUTING.rst
@@ -18,3 +18,20 @@ follow the conventions of the existing API.
 
 The build system runs ``tox -e tests,release`` on all supported Python
 versions. You can, and should, run this on your pull request before submitting.
+
+Building a Release
+==================
+Official releases are built and uploaded to PyPi using the GitHub |release workflow|_.
+To prepare a release, first, bump the ``__version__`` string in
+|pandora/__init__.py|_ and push a new release branch with the name
+``release-${version}`` where ``${version}`` is the version number from
+|pandora/__init__.py|_. The GitHub workflow will do the rest.
+
+The workflow does the same thing that is documented above with the addition of
+an upload to PyPi.
+
+.. |pandora/__init__.py| replace:: ``pandora/__init__.py``
+.. _pandora/__init__.py: https://github.com/mcrute/pydora/tree/master/pandora/__init__.py
+
+.. |release workflow| replace:: ``release`` workflow
+.. _release workflow: https://github.com/mcrute/pydora/blob/master/.github/workflows/release.yml