Skip to content

Commit 9aa422d

Browse files
authored
Merge pull request #11594 from pfmoore/release_docs
Update release docs to clarify some points
2 parents c81ab26 + 31ebba2 commit 9aa422d

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

docs/html/development/release-process.rst

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,15 @@ to need extra work before being released, the release manager always has the
3131
option to back out the partial change prior to a release. The PR can then be
3232
reworked and resubmitted for the next release.
3333

34+
Vendoring updates will be picked up fron the ``main`` branch, as for any other
35+
update. Ideally, vendoring updates should be merged between releases, just like
36+
any other change. If there are outstanding updates to vendored packages, the
37+
release manager *may* at their discretion choose to do a vendoring update
38+
before the release. However this is *not* a requirement and in particular,
39+
updates to vendored packages that fix issues in pip should be merged
40+
proactively, to ensure that they will be present in the next release.
41+
42+
3443
.. _`Deprecation Policy`:
3544

3645
Deprecation Policy
@@ -166,6 +175,11 @@ Sometimes we need to release a bugfix release of the form ``YY.N.Z+1``. In
166175
order to create one of these the changes should already be merged into the
167176
``main`` branch.
168177

178+
Note that this process is only needed when there are changes on the main branch
179+
that you do *not* want to include in the bugfix release. For a bugfix release
180+
that will include everything that is on the ``main`` branch, the above process
181+
for creating a new release can be used, simply changing the version number.
182+
169183
#. Create a new ``release/YY.N.Z+1`` branch off of the ``YY.N`` tag using the
170184
command ``git checkout -b release/YY.N.Z+1 YY.N``.
171185
#. Cherry pick the fixed commits off of the ``main`` branch, fixing any

0 commit comments

Comments
 (0)