Add End-of-life section to pep 101
This commit is contained in:
parent
7370df1f00
commit
5f4ce39c11
82
pep-0101.txt
82
pep-0101.txt
|
@ -752,6 +752,88 @@ What Next?
|
|||
You've just made a Python release!
|
||||
|
||||
|
||||
Moving to End-of-life
|
||||
=====================
|
||||
|
||||
Under current policy, a release branch normally reaches end-of-life status
|
||||
5 years after its initial release. The policy is discussed in more detail
|
||||
in `the Python Developer's Guide <https://devguide.python.org/devcycle/>`_.
|
||||
When end-of-life is reached, there are a number of tasks that need to be
|
||||
performed either directly by you as release manager or by ensuring someone
|
||||
else does them. Some of those tasks include:
|
||||
|
||||
- Optionally making a final release to publish any remaining unreleased
|
||||
changes.
|
||||
|
||||
- Check the `docsbuild server script
|
||||
<https://github.com/python/docsbuild-scripts/blob/master/build_docs.py>`_
|
||||
to ensure that the docs set for the branch is no longer being built.
|
||||
If still present, ask the DE to remove this branch from the BRANCHES list.
|
||||
|
||||
- On the docs download server (docs.nyc1.psf.io), ensure the top-level
|
||||
symlink points to the upload of unpacked html docs from final release::
|
||||
|
||||
cd /srv/docs.python.org
|
||||
ls -l 3.3
|
||||
lrwxrwxrwx 1 nad docs 13 Sep 6 21:38 3.3 -> release/3.3.7
|
||||
|
||||
- In each unretired cpython branch, remove any remaining references to the
|
||||
retired branch in the Doc version switcher and side bar templates
|
||||
(file names may vary between branches) [DE]::
|
||||
|
||||
Doc/tools/static/version_switch.js
|
||||
Doc/tools/templates/indexsidebar.html
|
||||
|
||||
- Freeze the state of the release branch by creating a tag of its current HEAD
|
||||
and then deleting the branch from the cpython repo. The current HEAD should
|
||||
be at or beyond the final security release for the branch::
|
||||
|
||||
git fetch upstream
|
||||
git tag --sign -m 'Final head of the former 3.3 branch' 3.3 upstream/3.3
|
||||
git push upstream refs/tags/3.3
|
||||
|
||||
- If all looks good, delete the branch. This may require the assistance of
|
||||
someone with repo administrator privileges::
|
||||
|
||||
git push upstream --delete 3.3 # or perform from Github Settings page
|
||||
|
||||
- Add retired notice to each release page on python.org for the retired branch.
|
||||
For example:
|
||||
|
||||
https://www.python.org/downloads/release/python-337/
|
||||
|
||||
https://www.python.org/downloads/release/python-336/
|
||||
|
||||
- In the developer's guide, add the branch to the recent end-of-life branches
|
||||
list (https://devguide.python.org/devcycle/#end-of-life-branches) and update
|
||||
or remove references to the branch elsewhere in the devguide.
|
||||
|
||||
- Retire the release from the bugs.python.org issue tracker. Tasks include:
|
||||
|
||||
* remove branch from tracker list of versions
|
||||
|
||||
* remove any release-release keywords (3.3regressions)
|
||||
|
||||
* review and dispose of open issues marked for this branch
|
||||
|
||||
Note, with the likely future migration of bug tracking from the current
|
||||
Roundup bugs.python.org to Github issues and with the impending end-of-life
|
||||
of Python 2.7, it probably makes sense to avoid unnecessary churn for
|
||||
currently and about-to-be retired 3.x branches by deferring any major
|
||||
wholesale changes to existing issues until the migration process is
|
||||
clarified.
|
||||
|
||||
- Announce the branch retirement in the usual places:
|
||||
|
||||
* mailing lists (python-committers, python-dev, python-list, python-announcements)
|
||||
|
||||
* discuss.python.org and Zulip
|
||||
|
||||
* Python Dev blog
|
||||
|
||||
- Enjoy your retirement and bask in the glow of a job well done!
|
||||
|
||||
|
||||
Windows Notes
|
||||
=============
|
||||
|
||||
|
|
Loading…
Reference in New Issue