Add python-releases.toml #4331
Add python-releases.toml #4331
Conversation
There was a problem hiding this comment.
Partial review:
From this, we automatically generate a
release-cycle.jsonfile as part of the build process, to be published onpeps.python.org. This replaces the version in the devguide.
Can we make all the data in the TOML also available in the JSON?
JSON is more universally supported, and we should make this data as widely usable as possible.
We don't necessarily need the JSON here to be an exact copy of the old devguide one; as long as the devguide can read the data it needs from this JSON to construct the diagram and tables.
Open questions:
- Any better ideas for a filename than
python-releases.toml?
Fine by me.
- Any better ideas for the metadata field names? I'm not a great fan of
start-of-developmentandend-of-bugfix, as all the others can be said aloud as "The {first release / feature freeze / end of life} is/was on {date}".
We could use the same names as the https://endoflife.date/ API.
The alpha https://endoflife.date/api/python.json currently uses:
releaseDate- initial releasesupport- end of bugfixeol- end of security support / life
Or the WIP v1 API (endoflife-date/endoflife.date#2080), https://deploy-preview-2080--endoflife-date.netlify.app/api/v1/products/python uses:
date- initial releaseeoasFrom- end of bugfix (end of active support)eolFrom- end of security support / life
pep_sphinx_extensions/pep_zero_generator/pep_index_generator.py
Outdated
Show resolved
Hide resolved
# Conflicts: # peps/pep-0596.rst # peps/pep-0619.rst # peps/pep-0664.rst # peps/pep-0693.rst # peps/pep-0719.rst
| if sys.version_info >= (3, 11): | ||
| from release_engineering.generate_release_cycle import create_release_cycle | ||
| else: | ||
| # this function uses tomllib, which requires Python 3.11+ |
There was a problem hiding this comment.
The comment would make more sense before line 31 or before line 30. This function here on lines 34-35 does not use tomllib!
But also, you could have a version-dependent dependency like tomli >= 1.1.0 ; python_version < "3.11" and a try/except import. But it’s up to you, I’m not well versed in release engineering to know when an older python would be used, and then whether a silent no-op is better than working or having a clear error 🙂
Inspired by #4314, this PR adds a transcription of every Python release since version 1.6 into a single TOML document,
python-releases.toml. This is intended to serve as a single, centralised, machine-readable record of Python's release history (and future).From this, we automatically generate a
release-cycle.jsonfile as part of the build process, to be published onpeps.python.org. This replaces the version in the devguide.The TOML document is used to (re-)generate the release schedules contained in release PEPs, initially starting with those for Python 3.8 to 3.14. The authoritative record and history remains the release PEP.
Some releases may need optional annotations or notes, which I have filled in for Python 3.8 and 3.9, but not yet back-filled.
Open questions:
python-releases.toml?start-of-developmentandend-of-bugfix, as all the others can be said aloud as "The {first release / feature freeze / end of life} is/was on {date}".A
📚 Documentation preview 📚: https://pep-previews--4331.org.readthedocs.build/
📚 Documentation preview 📚: https://pep-previews--4331.org.readthedocs.build/release-cycle.json