Skip to content

PEP 101: Remove DE tasks #4574

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

PEP 101: Remove DE tasks #4574

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
5 changes: 0 additions & 5 deletions peps/pep-0101.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -134,7 +134,6 @@ release. The roles and their current experts are:

* WE = Windows - Steve Dower <[email protected]>
* ME = Mac - Ned Deily <[email protected]> (US)
* DE = Docs - Julien Palard <[email protected]> (Central Europe)

.. note:: It is highly recommended that the RM contact the Experts the day
before the release. Because the world is round and everyone lives
Expand Down Expand Up @@ -388,8 +387,6 @@ and guides you to perform some manual steps.
``docs.nyc1.psf.io``. Make sure the files are in group ``docs`` and are
group-writeable.

- Let the DE check if the docs are built and work all right.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Arguably this step could be kept (modulo whoever does the checking), there have been recent releases where the docs haven't built properly, so it was important to check, even though CI failing/hanging alerted us to this.

A

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There's not actually a step in the automation scripts at https://github.com/python/release-tools that does this (or pauses to get someone to check it), other than the CI passing.

We could add one, if we can define something useful?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Arguably at minimum, the HTML files should seem fine at dip-test level, the EPUB file should pass EPUBcheck, the PDF archives should contain the expected files & not be corrupt, etc. These feel like reasonable checks?

A

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree with @AA-Turner's recommendation to add a minimum inspection of some of the doc artifacts. I would specifically add peeks at the HTML version of the What's New page and especially the changelog page as the latter is generated during the build process.


- Note both the documentation and downloads are behind a caching CDN. If
you change archives after downloading them through the website, you'll
need to purge the stale data in the CDN like this::
Expand Down Expand Up @@ -422,8 +419,6 @@ and guides you to perform some manual steps.

- Have you gotten the green light from the ME?

- Have you gotten the green light from the DE?

If green, it's time to merge the release engineering branch back into
the main repo.

Expand Down