Skip to content

Commit 04a8d00

Browse files
committed
Add release process
1 parent b0857c8 commit 04a8d00

File tree

1 file changed

+21
-1
lines changed

1 file changed

+21
-1
lines changed

docs/contributing.rst

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,27 @@ In order to run successfully, you will need all versions of Python installed. We
4848
$ pyenv install pypy2.7-7.1.1
4949
$ pyenv install pypy3.6-7.1.1
5050

51+
52+
Publishing a release (for maintainer role)
53+
==========================================
54+
55+
Maintainer tasks should always be kept to minimum. Once a release is ready, the suggested approach can be followed:
56+
57+
#. Create new branch release-X.Y.Z
58+
#. Update the HISTORY.rst file
59+
#. Update the `request_oauthlib/__init__.py`
60+
#. Raise a pull request to give a chance for all contributors to comment before publishing
61+
#. Create a TAG vX.Y.Z. By doing this, the pipeline will automatically trigger `twine` and will publish the release to PyPi.
62+
63+
Once verified, complete by doing the following:
64+
65+
#. Create a GitHub release vX.Y.Z in the Releases tab.
66+
#. Activate the vX.Y.Z version in the documentation (`ReadTheDocs`_)
67+
#. Merge the PR into master branch.
68+
69+
That's all.
70+
5171
.. _`tox`: https://tox.readthedocs.io/en/latest/install.html
5272
.. _`virtualenv`: https://virtualenv.pypa.io/en/latest/installation/
5373
.. _`pyenv`: https://github.com/pyenv/pyenv
54-
74+
.. _`ReadTheDocs`: https://readthedocs.org/projects/requests-oauthlib/versions/

0 commit comments

Comments
 (0)