Merge pull request #480 from requests/release-1.3.1

Release 1.3.1

Author: JonathanHuot

docs/conf.py

@@ -41,8 +41,8 @@
 master_doc = "index"
 
 # General information about the project.
-project = u"Requests-OAuthlib"
-copyright = u"2014, Kenneth Reitz"
+project = "Requests-OAuthlib"
+copyright = "2014, Kenneth Reitz"
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
@@ -188,8 +188,8 @@
     (
         "index",
         "Requests-OAuthlib.tex",
-        u"Requests-OAuthlib Documentation",
-        u"Requests-OAuthlib Contributors",
+        "Requests-OAuthlib Documentation",
+        "Requests-OAuthlib Contributors",
         "manual",
     )
 ]
@@ -223,8 +223,8 @@
     (
         "index",
         "requests-oauthlib",
-        u"Requests-OAuthlib Documentation",
-        [u"Requests-OAuthlib Contributors"],
+        "Requests-OAuthlib Documentation",
+        ["Requests-OAuthlib Contributors"],
         1,
     )
 ]
@@ -242,8 +242,8 @@
     (
         "index",
         "Requests-OAuthlib",
-        u"Requests-OAuthlib Documentation",
-        u"Requests-OAuthlib Contributors",
+        "Requests-OAuthlib Documentation",
+        "Requests-OAuthlib Contributors",
         "Requests-OAuthlib",
         "One line description of project.",
         "Miscellaneous",

docs/contributing.rst

@@ -48,7 +48,27 @@ In order to run successfully, you will need all versions of Python installed. We
    $ pyenv install pypy2.7-7.1.1
    $ pyenv install pypy3.6-7.1.1
 
+
+Publishing a release (for maintainer role)
+==========================================
+
+Maintainer tasks should always be kept to minimum. Once a release is ready, the suggested approach can be followed:
+
+#. Create new branch release-X.Y.Z
+#. Update the HISTORY.rst file
+#. Update the `request_oauthlib/__init__.py`
+#. Raise a pull request to give a chance for all contributors to comment before publishing
+#. Create a TAG vX.Y.Z. By doing this, the pipeline will automatically trigger `twine` and will publish the release to PyPi.
+
+Once verified, complete by doing the following:
+
+#. Create a GitHub release vX.Y.Z in the Releases tab.
+#. Activate the vX.Y.Z version in the documentation (`ReadTheDocs`_)
+#. Merge the PR into master branch.
+
+That's all.
+
 .. _`tox`: https://tox.readthedocs.io/en/latest/install.html
 .. _`virtualenv`: https://virtualenv.pypa.io/en/latest/installation/
 .. _`pyenv`: https://github.com/pyenv/pyenv
-
+.. _`ReadTheDocs`: https://readthedocs.org/projects/requests-oauthlib/versions/

tox.ini

@@ -36,4 +36,4 @@ commands=
 [testenv:black]
 basepython=python3.7
 deps=black
-commands=black --check .
+commands=black --check --diff .