Skip to content

Move docs build into the Checks workflow - #1502

Open
cristianrgreco wants to merge 1 commit into
mainfrom
claude/move-docs-build-into-checks
Open

cristianrgreco wants to merge 1 commit into
mainfrom
claude/move-docs-build-into-checks

Conversation

@cristianrgreco

Copy link
Copy Markdown
Collaborator

Summary

  • Run the strict docs build as a Docs job in the Checks workflow instead of a separate Docs workflow, so it reports as Checks / Docs alongside the other checks. docs.yml is removed.
  • Remove paths-ignore from Checks so the docs job runs on docs-only changes. changed-modules.mjs already ignores README.md, docs/** and mkdocs.yml, so lint, compile, smoke tests and tests still skip for those changes; only Detect packages to check (~5s) newly runs.
  • Checks complete now needs docs and runs with if: always(), so a failed docs build fails it on docs-only changes too. Previously it was skipped when no packages changed.
  • Drop the Netlify Python version comment from the docs job.

Verification

  • npm run format — no fixes applied
  • npm run lint — no fixes applied
  • printf 'docs/index.md\nmkdocs.yml\nREADME.md\n' | node .github/scripts/changed-modules.mjs — prints [], confirming the package jobs skip for docs-only changes
  • Parsed checks.yml as YAML and confirmed the job list and the end job's needs

The workflow itself is exercised by this PR's own run. Because checks.yml counts as an all-packages change, this PR runs the full matrix.

Not breaking

CI-only change; no published package code, public API or docs content is touched. The main ruleset has no required status checks, so renaming Docs / Build docs to Checks / Docs does not affect merging.

Run the strict docs build as a Docs job in Checks instead of a separate Docs workflow, so it reports as Checks / Docs alongside the other checks.

Checks previously skipped docs-only changes with paths-ignore. That filter is removed so the docs job runs for them; changed-modules.mjs already ignores the same paths, so lint, compile, smoke tests and tests still skip.

Checks complete now depends on the docs job and always runs, so a failed docs build fails it on docs-only changes too.
@cristianrgreco cristianrgreco added maintenance Improvements that do not change functionality patch Backward compatible bug fix labels Oct 11, 2026

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

maintenance Improvements that do not change functionality patch Backward compatible bug fix

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant