Skip to content

Commit

Permalink
PEP 1, 12: Update and simplify outdated legacy rendering workflow steps
Browse files Browse the repository at this point in the history
  • Loading branch information
CAM-Gerlach committed Mar 19, 2022
1 parent a23937e commit 046faf7
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 23 deletions.
31 changes: 10 additions & 21 deletions pep-0001.txt
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,9 @@ documenting dissenting opinions.

Because the PEPs are maintained as text files in a versioned
repository, their revision history is the historical record of the
feature proposal [1]_.
feature proposal. This historical record is available by the normal git
commands for retrieving older revisions, and can also be browsed
`on GitHub <https://github.com/python/peps>`__.


PEP Audience
Expand Down Expand Up @@ -285,8 +287,8 @@ the PEP Sponsor and PEP editors can advise them accordingly.

If the chosen venue is not the `Python-Dev`_ mailing list,
a brief announcement should be posted there when the draft PEP is
committed to the PEP repository and available on the PEP website,
with a link to the rendered PEP and to the canonical ``Discussions-To`` thread.
committed to the repository, which should include a link to the rendered PEP
and to the canonical ``Discussions-To`` thread.

If a PEP undergoes a significant re-write or other major, substantive
changes to its proposed specification, a new thread should typically be created
Expand Down Expand Up @@ -791,22 +793,13 @@ Once the PEP is ready for the repository, a PEP editor will:
("Standards Track", "Informational", or "Process"), and marked its
status as "Draft".

* Add the PEP to a local fork of the `PEP repository`_. For workflow
instructions, follow `The Python Developers Guide <https://devguide.python.org/>`_
* Ensure all CI build and lint checks pass without errors,
and there are no obvious issues in the rendered preview output.

* Run ``./build.py`` to ensure the PEPs are generated without errors. If the
rendering triggers errors, then the web site will not be updated to reflect
the PEP changes.
* Merge the new (or updated) PEP.

* Commit and push the new (or updated) PEP

* Monitor python.org to make sure the PEP gets added to the site
properly. If it fails to appear, running ``make`` will build all of the
current PEPs. If any of these are triggering errors, they must be
corrected before any PEP will update on the site.

* Send email back to the PEP author with next steps (post to
python-list & -dev).
* Inform the author of the next steps (open a discussion thread and
update the PEP with it, post an announcement to Python-Dev, etc).

Updates to existing PEPs should be submitted as a `GitHub pull request`_.

Expand All @@ -831,10 +824,6 @@ Resources:
Footnotes
=========

.. [1] This historical record is available by the normal git commands
for retrieving older revisions, and can also be browsed
`on GitHub <https://github.com/python/peps>`__.

.. _.github/CODEOWNERS: https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners

.. _issue tracker: https://bugs.python.org/
Expand Down
6 changes: 4 additions & 2 deletions pep-0012.rst
Original file line number Diff line number Diff line change
Expand Up @@ -152,8 +152,10 @@ directions below.
- Update your Footnotes section, listing any footnotes and
non-inline link targets referenced by the text.

- Create a pull request against the https://github.com/python/peps
repository.
- Run ``./build.py`` to ensure the PEP is rendered without errors,
and check that the output in ``build/pep-9999.html`` looks as you intend.

- Create a pull request against the `PEPs repository`_.

For reference, here are all of the possible header fields (everything
in brackets should either be replaced or have the field removed if
Expand Down

0 comments on commit 046faf7

Please sign in to comment.