Repository navigation
Move docs build into the Checks workflow - #1502
Open
cristianrgreco wants to merge 1 commit into
Open
cristianrgreco wants to merge 1 commit into
cristianrgreco wants to merge 1 commit into
Conversation
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.
This branch has not been deployed
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.
Summary
Docsjob in theChecksworkflow instead of a separateDocsworkflow, so it reports asChecks / Docsalongside the other checks.docs.ymlis removed.paths-ignorefromChecksso the docs job runs on docs-only changes.changed-modules.mjsalready ignoresREADME.md,docs/**andmkdocs.yml, so lint, compile, smoke tests and tests still skip for those changes; onlyDetect packages to check(~5s) newly runs.Checks completenow needsdocsand runs withif: always(), so a failed docs build fails it on docs-only changes too. Previously it was skipped when no packages changed.Verification
npm run format— no fixes appliednpm run lint— no fixes appliedprintf 'docs/index.md\nmkdocs.yml\nREADME.md\n' | node .github/scripts/changed-modules.mjs— prints[], confirming the package jobs skip for docs-only changeschecks.ymlas YAML and confirmed the job list and theendjob'sneedsThe workflow itself is exercised by this PR's own run. Because
checks.ymlcounts 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
mainruleset has no required status checks, so renamingDocs / Build docstoChecks / Docsdoes not affect merging.