aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--CONTRIBUTING.rst17
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.
18 18
19The build system runs ``tox -e tests,release`` on all supported Python 19The build system runs ``tox -e tests,release`` on all supported Python
20versions. You can, and should, run this on your pull request before submitting. 20versions. You can, and should, run this on your pull request before submitting.
21
22Building a Release
23==================
24Official releases are built and uploaded to PyPi using the GitHub |release workflow|_.
25To prepare a release, first, bump the ``__version__`` string in
26|pandora/__init__.py|_ and push a new release branch with the name
27``release-${version}`` where ``${version}`` is the version number from
28|pandora/__init__.py|_. The GitHub workflow will do the rest.
29
30The workflow does the same thing that is documented above with the addition of
31an upload to PyPi.
32
33.. |pandora/__init__.py| replace:: ``pandora/__init__.py``
34.. _pandora/__init__.py: https://github.com/mcrute/pydora/tree/master/pandora/__init__.py
35
36.. |release workflow| replace:: ``release`` workflow
37.. _release workflow: https://github.com/mcrute/pydora/blob/master/.github/workflows/release.yml