diff options
| author | Seth Michael Larson <sethmichaellarson@gmail.com> | 2019-01-21 08:34:21 -0600 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2019-01-21 08:34:21 -0600 |
| commit | a14fbc27467197e83672903297140ea05049bfd4 (patch) | |
| tree | 81ba8cb29a878ba0220f7733318d4c2e06d15d11 /docs | |
| parent | d5e0eb64dd14840cd3794fabcd81ee52a5e6f3e8 (diff) | |
| download | urllib3-a14fbc27467197e83672903297140ea05049bfd4.tar.gz | |
Deploy to GitHub and PyPI on tags (#1508)
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/contributing.rst | 28 |
1 files changed, 25 insertions, 3 deletions
diff --git a/docs/contributing.rst b/docs/contributing.rst index 85b030d8..39e47d7e 100644 --- a/docs/contributing.rst +++ b/docs/contributing.rst @@ -65,9 +65,31 @@ suite:: Our test suite `runs continuously on Travis CI <https://travis-ci.org/urllib3/urllib3>`_ with every pull request. - -Sponsorship & Project Grants ----------------------------- +Releases +-------- + +A release candidate can be created by any contributor by creating a branch +named ``release-x.x`` where ``x.x`` is the version of the proposed release. + +- Update ``CHANGES.rst`` and ``urllib3/__init__.py`` with the proper version number + and commit the changes to ``release-x.x``. +- Open a pull request to merge the ``release-x.x`` branch into the ``master`` branch. +- Integration tests are run against the release candidate on Travis. From here on all + the steps below will be handled by a maintainer so unless you receive review comments + you are done here. +- Once the pull request is squash merged into master the merging maintainer the + pull request will tag the merge commit with the version number: + + - ``git tag -a 1.24.1 [commit sha]`` + - ``git push origin master --tags`` + +- After the commit is tagged Travis will build the tagged commit and upload the sdist and wheel + to PyPI and create a draft release on GitHub for the tag. The merging maintainer will + ensure that the PyPI sdist and wheel are properly uploaded. +- The merging maintainer will mark the draft release on GitHub as an approved release. + +Sponsorship +----------- .. |tideliftlogo| image:: https://nedbatchelder.com/pix/Tidelift_Logos_RGB_Tidelift_Shorthand_On-White_small.png :width: 75 |