Repository navigation
docs(contributing): draw pep.rst's release-trigger chain as a Mermaid graph - #963
Merged
Merged
Conversation
… graph Part of #719: convert the ASCII `->` chain in "Release Plan" to a `.. mermaid::` flowchart, matching the style already established in workflows.rst and releasing.rst (flowchart TD, short node IDs, `<br/>` for two-line labels, thick `==>` for `workflow_run` edges). - The old ASCII diagram skipped a hop and misattributed a trigger: it showed `push to main -> Vendor Update`, captioned "which triggers on push to main". `cron-vendor.yml:6-13`'s own comment says the opposite -- it deliberately carries no `push` trigger, to avoid re-running Unit Tests' gate job twice for the same commit (#715). The real chain is push to main -> Unit Tests -> Vendor Update -> Create Release, each hop after the first a `workflow_run` edge. Verified against cron-vendor.yml, create-release.yml and unit-tests.yml directly. - Cross-referenced :doc:`workflows`, which already draws the repository-wide version of this graph, rather than duplicating it. - Swept the rest of the file for other flow-shaped prose and for drift against the three named workflow files; found no other ASCII/text diagrams and no other inaccuracies (the per-job `if:` gating paragraph and the Python-version test-matrix claim both checked out against the current workflow files).
Owner
Author
|
GOOD TO GO at I re-derived its load-bearing claims rather than relaying them:
No full Sphinx build was run on either side; the structural-subset argument plus Omitting the Saturday |
This was referenced Oct 1, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Please follow the guide below
make pylint,make mypy,make isort) -- N/A, docs onlymake testpasses, and a test case covers the changedocs/source/changelog/-- N/A — centralised in docs(changelog): shared 1.5.0 changelog — long-lived, merges last (#610, #616, #617, #618, #620) #657What is the purpose of your pull request?
docs— documentation onlyDescription
Part of #719 (
docs/source/contributing/pep.rstslice), per the repo owner's ruling there: prefer a Mermaid graph over a paragraph/ASCII diagram where the subject is a flow.Converted: the
.. code-block:: textASCII chain in "Release Plan" (push to main -> Vendor Update -> Create Release) to a.. mermaid::flowchart, styled to match the three existing directives inworkflows.rst/releasing.rst(flowchart TD, short node IDs,<br/>labels, thick==>forworkflow_run).Factual fix found while verifying: the old diagram skipped a hop and misattributed a trigger. It said
cron-vendor.ymltriggers on push tomain— butcron-vendor.yml:6-13's own comment says it deliberately carries no push trigger (to avoid double-running Unit Tests' gate job, #715). The real chain is push tomain→ Unit Tests → Vendor Update → Create Release, verified againstcron-vendor.yml,create-release.yml, andunit-tests.ymldirectly.Considered and rejected: the "Every publishing job… is gated on" paragraph (per-job
if:rationale) and the "Delivery Sequence" wave ordering — both are "why" rationale a diagram can't carry, so left as prose. No other ASCII diagrams exist in the file. Checkedunit-tests.yml:58-59for the 3.10–3.14 matrix claim atpep.rst:552— accurate, unchanged.Cross-references
:doc:workflows`` rather than duplicating its repository-wide graph.