From 95b3f19c042b8dd582a46c1b58e2b0c5e81f4d5b Mon Sep 17 00:00:00 2001 From: Mike Crute Date: Tue, 9 Jun 2020 02:57:46 +0000 Subject: Document how releases are built --- CONTRIBUTING.rst | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) 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 -- cgit v1.2.3