Repository navigation
docs(ci): cite unit-tests.yml by step name, not line (#1967) - #2027
Merged
Merged
Conversation
JarryShaw
added
docs
Owner
Author
|
GOOD TO GO at |
JarryShaw
added
review: good-to-go
4 of 5 tasks
Owner
Author
|
resolve conflicts |
- releasing.rst, workflows.rst: replace every `unit-tests.yml:N` citation with the job, step `name:`, or comment it pointed at. - TestWorkflowsCitedByName: add `unit-tests.yml` to `BY_NAME`, so a line citation of it, or a bare `:N` beside it, fails. - Drop `CITATIONS` and `TestDocCitationsResolve`, the line anchors the by-name rule replaces.
JarryShaw
force-pushed
the
ci/1967-step2-unit-tests-by-name
branch
from
October 22, 2026 02:41
a9dd295 to
7c96448
Compare
Owner
Author
|
Rebased onto |
4 of 5 tasks
Contributor
|
Coverage: 91.54% (unit tier, Python 3.15,
Per-file detail: the |
JarryShaw
removed
the
review: good-to-go
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.
make pylint,make mypy,make isort)make testpasses, and a test case covers the changeWhat is the purpose of your pull request?
docs— documentation onlyDescription of your pull request and other information
#1967 step 2, item 1. #2023 has landed, so this is one commit on
main.unit-tests.yml:Ncitation inreleasing.rstandworkflows.rstnow names its job, step or comment instead (gate, thechangelogjob's "Check CHANGELOG.md is in step with its source entry" step,required-checksand its "Check every required job succeeded" step, the comments abovechangelogandtest-ktlo). I checked each one against the line it used to point at.TestWorkflowsCitedByNamenow coversunit-tests.yml.CITATIONSandTestDocCitationsResolveare gone, as ci: fix shellcheck findings and trim workflow comments (#1967) #2023 removedRELEASE_CITATIONS.The extended check fails on #2023's head (
2 failed, one per page) and passes here (39 passed). The test files that read either page orunit-tests.ymlgive756 passed, 4 skipped. No other tracked file citesunit-tests.ymlby line.Next come
util/regenerate_samples.py,util/pip_install.pyand thenutil/apt_packages.py(in Python, per the ruling on #1967), each stacked on the one before.