Skip to content

Note when to backport changes #1169

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
hugovk merged 6 commits into from
Oct 6, 2023
Merged

Note when to backport changes #1169

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
35e855b
docs(#1168): add directive on backporting
JacobCoffee Sep 28, 2023
9e91c45
fix(docs): apply suggestions
JacobCoffee Sep 28, 2023
05cfc3f
Update developer-workflow/development-cycle.rst
JacobCoffee Sep 29, 2023
5bd59e2
Update developer-workflow/development-cycle.rst
JacobCoffee Oct 5, 2023
7b9bff6
Update developer-workflow/development-cycle.rst
JacobCoffee Oct 5, 2023
4b7de3a
Update developer-workflow/development-cycle.rst
JacobCoffee Oct 5, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
docs(#1168): add directive on backporting
  • Loading branch information
@JacobCoffee
JacobCoffee committed Sep 28, 2023
commit 35e855bca84f9c61197c1a5f6dd1d1e4c947ca44
17 changes: 14 additions & 3 deletions developer-workflow/development-cycle.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,10 +77,21 @@ releases; the terms are used interchangeably. These releases have a
**micro version** number greater than zero.

The only changes allowed to occur in a maintenance branch without debate are
bug fixes. Also, a general rule for maintenance branches is that compatibility
Comment thread
JacobCoffee marked this conversation as resolved.
bug fixes. Also, a general rule for maintenance branches is that compatibility
must not be broken at any point between sibling micro releases (3.5.1, 3.5.2,
etc.). For both rules, only rare exceptions are accepted and **must** be
discussed first.
etc.). For both rules, only rare exceptions are accepted and **must** be
discussed first. Among the rare exceptions to the rules of bug fixes and compatibility,
backporting of documentation and tests is encouraged.
Comment thread
JacobCoffee marked this conversation as resolved.
Outdated

Backporting serves dual purposes. First, it increases the visibility of
documentation changes since most users refer to stable versions at
`docs.python.org/3/ <https://docs.python.org/3/>`_ rather
than the `docs.python.org/dev/ <https://docs.python.org/dev/>`_ documentation.
Second, it minimizes conflicts for future bugfix backports.

Backporting should target enhancements in documentation and tests for
currently **stable** versions, specifically branches in a **bugfix** release cycle
or higher.
Comment thread
JacobCoffee marked this conversation as resolved.
Outdated

A new maintenance branch is normally created when the next feature release
cycle reaches feature freeze, i.e. at its first beta pre-release.
Expand Down
3 changes: 2 additions & 1 deletion versions.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,8 @@ Status key
but new source-only versions can be released
:end-of-life: release cycle is frozen; no further changes can be pushed to it.

See also the :ref:`devcycle` page for more information about branches.
See also :ref:`devcycle` for branch information and :ref:`maintbranch` for details on
backporting documentation and test changes above the **bugfix** level.

By default, the end-of-life is scheduled 5 years after the first release,
but can be adjusted by the release manager of each branch. All Python 2
Comment thread
JacobCoffee marked this conversation as resolved.
Expand Down