Merged
Conversation
There was a problem hiding this comment.
Pull request overview
This PR introduces a “docs-only” CI workflow and aligns existing PR workflows’ path filters so documentation-only changes run a lighter docs pipeline while code-focused workflows skip docs paths. It also separates schema validation from docs validation by moving docs checks into the new docs workflow, and adds MDX support to path filters.
Changes:
- Added a new docs-only workflow (
docs-shim.yaml) to run pre-commit (with Go hooks skipped),docs:test, anduds-docs-validateon docs-related PR changes. - Split schema validation away from docs validation by updating
test-schema.yamlto validate schema only. - Standardized PR workflow
paths-ignorelists (including adding**.mdx) across multiple workflows.
Reviewed changes
Copilot reviewed 7 out of 7 changed files in this pull request and generated 8 comments.
Show a summary per file
| File | Description |
|---|---|
| .github/workflows/docs-shim.yaml | New docs-only CI workflow (lint/docs test/link check) gated by paths. |
| .github/workflows/test-schema.yaml | Removes docs checks; adds paths-ignore so schema validation skips docs-path PRs. |
| .github/workflows/test-unit.yaml | Updates paths-ignore to align with the new canonical docs/meta ignore set and adds MDX. |
| .github/workflows/test-e2e-pr.yaml | Updates paths-ignore to align with the canonical docs/meta ignore set and adds MDX. |
| .github/workflows/scan-codeql.yaml | Updates paths-ignore to align with the canonical docs/meta ignore set and adds MDX. |
| .github/workflows/scan-lint.yaml | Adds paths-ignore so lint scanning skips docs/meta-only PRs. |
| .github/workflows/callable-lint.yaml | Adds paths-ignore to avoid running the lint workflow on docs/meta-only PRs. |
Comments suppressed due to low confidence (2)
.github/workflows/test-schema.yaml:20
- To keep the complement filter pattern described in the PR (docs-shim
pathsmirrored by other workflows’paths-ignore), this ignore list should also include.github/workflows/docs-shim.yamlsince the docs-shim workflow’spathsincludes it. Otherwise a PR that only edits the docs-shim workflow will still run the schema validation workflow.
.github/workflows/test-schema.yaml:20 hack/**is now ignored for this workflow, which will preventschema:testfrom running when schema generation/test scripts underhack/change (e.g.,hack/test-generate-schema.shis invoked by the schema task). Consider not ignoringhack/**here, or narrowing the ignore list to docs-only hack scripts.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
mjnagel
reviewed
Mar 20, 2026
95da71e to
184cd99
Compare
mjnagel
reviewed
Mar 26, 2026
Contributor
mjnagel
left a comment
There was a problem hiding this comment.
Few small comments - generally looks good.
mjnagel
approved these changes
Mar 26, 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.
Description
docs-shim.yamlCI workflow that runs only on docs-related PRs, providing lint (pre-commit with Go hooks skipped), docs generation validation (docs:test), and docs site link checking (uds-docs-validate)paths-ignoreacross all code-focused PR workflows (test-e2e-pr,test-unit,scan-codeql,scan-lint,callable-lint,test-schema) so they skip on the same set of docs pathstest-schema-and-docs.yamlintotest-schema.yaml(code PRs only) and movesdocs:testinto the docs-shim (docs PRs only)**.mdxto all path filters since uds-cli docs use MDXThe docs-shim
pathsand all other workflows'paths-ignoreare exact mirrors, following the same complement pattern used in uds-core: docs-only PRs trigger only the docs-shim, code PRs trigger everything else.Files changed
docs-shim.yamltest-schema-and-docs.yaml→test-schema.yamldocs:test(moved to docs-shim), removeddocs-link-check(moved to docs-shim)test-e2e-pr.yamlpaths-ignoreto match canonical listtest-unit.yamlpaths-ignoreto match canonical listscan-codeql.yamlpaths-ignoreto match canonical listscan-lint.yamlpaths-ignore(previously ran on all PRs)callable-lint.yamlpaths-ignore(previously ran on all PRs)Related Issue
Fixes core-441
Type of change
Checklist before merging