Repository navigation
Conversation
Splitting link checking out of docs-lint lets a CI workflow run it in its own job, separate from the faster code and docs linters. Link checking is slow and hits the network, so it slows down every other lint job that depends on it. docs-lint keeps running sphinx-lint, spelling, and woke. make lint still runs linkcheck, so local behaviour and the full lint target are unchanged. Co-Authored-By: Copilot <198982749+Copilot@users.noreply.github.com>
This was referenced Oct 14, 2026
Contributor
There was a problem hiding this comment.
🟢 Approval recommended
No unresolved review issues remain.
0 open findings
What changed in this PR
Adds a standalone documentation link-check target while preserving aggregate lint behavior.
Changes:
- Adds
docs-linkcheckfor standalone link checking. - Includes it in the aggregate
linttarget. - Keeps other documentation checks separate.
| File | Description |
|---|---|
Makefile |
Includes link checking in aggregate linting. |
common.mk |
Defines the standalone docs-linkcheck target. |
🧠 Review effort: Lite
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
This was referenced Oct 15, 2026
This was referenced Oct 15, 2026
lengau
marked this pull request as ready for review
October 22, 2026 17:04
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.
Problem
canonical/starflow/.github/workflows/lint-python.yamlruns all code anddocumentation linters in a single job. Link checking is slow and hits the
network, so it slows down every job that depends on it.
To split linting into separate CI jobs,
linkcheckneeds to be a standaloneMake target rather than part of
docs-lint.Changes
docs-linkchecktarget that runsmake -C docs linkcheck.linkcheckfromdocs-lint, which keeps runningsphinx-lint,spelling, andwoke.docs-linkcheckas a prerequisite oflint, somake lintand localbehaviour are unchanged.
Downstream repos get the new target automatically the next time they merge
from
starbase/main.Compatibility testing
This PR is only the starbase half. The starflow half that consumes it is
canonical/starflow#199.
The merge order matters, so both orders are tested by these draft PRs:
main:ci: test starbase with starflow's split lint workflow #626. Based on this branch, points the
lintjob atstarflow's
work/separate-linkcheck.main:ci: test starbase main with starflow's split lint workflow #627. Based on
main, points thelintjob at starflow'swork/separate-linkcheck. Thelinkcheckjob is expected to fail, sincedocs-linkcheckdoes not exist onmain.If #627 fails, starbase has to land before starflow.
Each of those two test PRs also has a docs-only PR stacked on top of it,
to check the filter classifies a documentation-only change correctly and
skips the code linters:
The same two stacks also each have a PR that changes a source file and a
documentation file together, to check that all three linting jobs run rather
than only one:
Test plan
make format,make lint,make test-fast