diff options
| -rw-r--r-- | README.rst | 2 | ||||
| -rw-r--r-- | docs/development.rst | 32 |
2 files changed, 16 insertions, 18 deletions
diff --git a/README.rst b/README.rst index 6c343c774..a10c06dd2 100644 --- a/README.rst +++ b/README.rst @@ -19,7 +19,7 @@ tool for installing Python packages. .. image:: https://img.shields.io/pypi/v/pip.svg :target: https://pypi.python.org/pypi/pip -.. image:: https://img.shields.io/travis/pypa/pip/develop.svg +.. image:: https://img.shields.io/travis/pypa/pip/master.svg :target: http://travis-ci.org/pypa/pip .. image:: https://readthedocs.org/projects/pip/badge/?version=stable diff --git a/docs/development.rst b/docs/development.rst index 95b4df1ac..52daef6ab 100644 --- a/docs/development.rst +++ b/docs/development.rst @@ -5,7 +5,7 @@ Development Pull Requests ============= -- Submit Pull Requests against the `develop` branch. +- Submit Pull Requests against the `master` branch. - Provide a good description of what you're doing and why. - Provide tests that cover your changes and try to run the tests locally first. @@ -37,8 +37,8 @@ click "New pull request". That's it. Automated Testing ================= -All pull requests and merges to 'develop' branch are tested in `Travis <https://travis-ci.org/>`_ -based on our `.travis.yml file <https://github.com/pypa/pip/blob/develop/.travis.yml>`_. +All pull requests and merges to 'master' branch are tested in `Travis <https://travis-ci.org/>`_ +based on our `.travis.yml file <https://github.com/pypa/pip/blob/master/.travis.yml>`_. Usually, a link to your specific travis build appears in pull requests, but if not, you can find it on our `travis pull requests page <https://travis-ci.org/pypa/pip/pull_requests>`_ @@ -91,22 +91,20 @@ and they will initiate a vote. Release Process =============== -1. On the current pip ``develop`` branch, generate a new ``AUTHORS.txt`` by +#. On the current pip ``master`` branch, generate a new ``AUTHORS.txt`` by running ``invoke generate.authors`` and commit the results. -2. On the current pip ``develop`` branch, make a new commit which bumps the +#. On the current pip ``master`` branch, make a new commit which bumps the version in ``pip/__init__.py`` to the release version and adjust the ``CHANGES.txt`` file to reflect the current date. -3. Merge the ``develop`` branch into the ``master`` branch. -4. Create a signed tag of the ``master`` branch of the form ``X.Y.Z`` using the +#. Create a signed tag of the ``master`` branch of the form ``X.Y.Z`` using the command ``git tag -s X.Y.Z``. -5. Checkout the tag using ``git checkout X.Y.Z`` and create the distribution +#. Checkout the tag using ``git checkout X.Y.Z`` and create the distribution files using ``python setup.py sdist bdist_wheel``. -6. Upload the distribution files to PyPI using twine +#. Upload the distribution files to PyPI using twine (``twine upload -s dist/*``). The upload should include GPG signatures of the distribution files. -7. Merge the ``master`` branch into the ``develop`` branch. -8. Push all of the changes. -9. Regenerate the ``get-pip.py`` script by running +#. Push all of the changes. +#. Regenerate the ``get-pip.py`` script by running ``invoke generate.installer`` in the get-pip repository, and committing the results. @@ -116,14 +114,14 @@ Creating a Bugfix Release Sometimes we need to release a bugfix release of the form ``X.Y.Z+1``. In order to create one of these the changes should already be merged into the -``develop`` branch. +``master`` branch. -1. Create a new ``release/X.Y.Z+1`` branch off of the ``X.Y.Z`` tag using the +#. Create a new ``release/X.Y.Z+1`` branch off of the ``X.Y.Z`` tag using the command ``git checkout -b release/X.Y.Z+1 X.Y.Z``. -2. Cherry pick the fixed commits off of the develop branch, fixing any +#. Cherry pick the fixed commits off of the ``master`` branch, fixing any conflicts and moving any changelog entries from the development version's changelog section to the ``X.Y.Z+1`` section. -3. Push the ``release/X.Y.Z+1`` branch to github and submit a PR for it against +#. Push the ``release/X.Y.Z+1`` branch to github and submit a PR for it against the ``master`` branch and wait for the tests to run. -4. Once tests run, merge the ``release/X.Y.Z+1`` branch into master, and follow +#. Once tests run, merge the ``release/X.Y.Z+1`` branch into master, and follow the above release process starting with step 4. |