Skip to content

Commit ccfd119

Browse files
authored
Merge pull request #7241 from xavfernandez/update_release_doc
Update release doc
2 parents 618e975 + 7c218c9 commit ccfd119

File tree

1 file changed

+23
-2
lines changed

1 file changed

+23
-2
lines changed

docs/html/development/release-process.rst

+23-2
Original file line numberDiff line numberDiff line change
@@ -107,6 +107,23 @@ Creating a new release
107107
Steps 3 to 6 are automated in ``nox -s release -- YY.N`` command.
108108

109109

110+
.. note::
111+
112+
If the release dropped the support of an obsolete Python version ``M.m``,
113+
a new ``M.m/get-pip.py`` needs to be published: update the ``all`` task from
114+
``tasks/generate.py`` in `get-pip repository`_ and make a pull request to
115+
`psf-salt repository`_ to add the new ``get-pip.py`` (and its directory) to
116+
``salt/pypa/bootstrap/init.sls``.
117+
118+
119+
.. note::
120+
If the ``get-pip.py`` script needs to be updated due to changes in pip internals
121+
and if the last ``M.m/get-pip.py`` published still uses the default template, make
122+
sure to first duplicate ``templates/default.py`` as ``templates/pre-YY.N.py``
123+
before updating it and specify in ``tasks/generate.py`` that ``M.m/get-pip.py``
124+
now needs to use ``templates/pre-YY.N.py``.
125+
126+
110127
Creating a bug-fix release
111128
--------------------------
112129

@@ -117,12 +134,16 @@ order to create one of these the changes should already be merged into the
117134
#. Create a new ``release/YY.N.Z+1`` branch off of the ``YY.N`` tag using the
118135
command ``git checkout -b release/YY.N.Z+1 YY.N``.
119136
#. Cherry pick the fixed commits off of the ``master`` branch, fixing any
120-
conflicts and moving any changelog entries from the development version's
121-
changelog section to the ``YY.N.Z+1`` section.
137+
conflicts.
138+
#. Follow the steps 3 to 6 from above (or call ``nox -s release -- YY.N.Z+1``)
139+
#. Merge master into your release branch and drop the news files that have been
140+
included in your release (otherwise they would also appear in the ``YY.N+1``
141+
changelog)
122142
#. Push the ``release/YY.N.Z+1`` branch to github and submit a PR for it against
123143
the ``master`` branch and wait for the tests to run.
124144
#. Once tests run, merge the ``release/YY.N.Z+1`` branch into master, and follow
125145
the above release process starting with step 4.
126146

127147
.. _`get-pip repository`: https://github.com/pypa/get-pip
148+
.. _`psf-salt repository`: https://github.com/python/psf-salt
128149
.. _`CPython`: https://github.com/pypa/cpython

0 commit comments

Comments
 (0)