Skip to content

fix: add docs shim#1354

Merged
chance-coleman merged 4 commits intomainfrom
chance/core-441-uds-cli-docs-shim
Mar 26, 2026
Merged

fix: add docs shim#1354
chance-coleman merged 4 commits intomainfrom
chance/core-441-uds-cli-docs-shim

Conversation

@chance-coleman
Copy link
Copy Markdown
Contributor

Description

  • Adds a docs-shim.yaml CI 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)
  • Standardizes paths-ignore across 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 paths
  • Splits test-schema-and-docs.yaml into test-schema.yaml (code PRs only) and moves docs:test into the docs-shim (docs PRs only)
  • Adds **.mdx to all path filters since uds-cli docs use MDX

The docs-shim paths and all other workflows' paths-ignore are 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

File Change
docs-shim.yaml New — docs CI workflow with lint-check, docs-test, docs-link-check
test-schema-and-docs.yamltest-schema.yaml Renamed — removed docs:test (moved to docs-shim), removed docs-link-check (moved to docs-shim)
test-e2e-pr.yaml Updated paths-ignore to match canonical list
test-unit.yaml Updated paths-ignore to match canonical list
scan-codeql.yaml Updated paths-ignore to match canonical list
scan-lint.yaml Added paths-ignore (previously ran on all PRs)
callable-lint.yaml Added paths-ignore (previously ran on all PRs)

Related Issue

Fixes core-441

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Other (security config, docs update, etc)

Checklist before merging

@chance-coleman chance-coleman self-assigned this Mar 18, 2026
@chance-coleman chance-coleman marked this pull request as ready for review March 19, 2026 19:24
@chance-coleman chance-coleman requested a review from a team as a code owner March 19, 2026 19:24
@joelmccoy joelmccoy requested a review from Copilot March 19, 2026 21:17
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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, and uds-docs-validate on docs-related PR changes.
  • Split schema validation away from docs validation by updating test-schema.yaml to validate schema only.
  • Standardized PR workflow paths-ignore lists (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 paths mirrored by other workflows’ paths-ignore), this ignore list should also include .github/workflows/docs-shim.yaml since the docs-shim workflow’s paths includes 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 prevent schema:test from running when schema generation/test scripts under hack/ change (e.g., hack/test-generate-schema.sh is invoked by the schema task). Consider not ignoring hack/** 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.

Comment thread .github/workflows/docs-shim.yaml
Comment thread .github/workflows/test-e2e-pr.yaml Outdated
Comment thread .github/workflows/scan-codeql.yaml Outdated
Comment thread .github/workflows/callable-lint.yaml Outdated
Comment thread .github/workflows/docs-shim.yaml Outdated
Comment thread .github/workflows/test-unit.yaml Outdated
Comment thread .github/workflows/test-unit.yaml Outdated
Comment thread .github/workflows/scan-lint.yaml Outdated
Comment thread .github/workflows/docs-shim.yaml Outdated
Comment thread .github/workflows/docs-shim.yaml Outdated
@chance-coleman chance-coleman force-pushed the chance/core-441-uds-cli-docs-shim branch 2 times, most recently from 95da71e to 184cd99 Compare March 20, 2026 01:40
Copy link
Copy Markdown
Contributor

@mjnagel mjnagel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Few small comments - generally looks good.

Comment thread .github/workflows/docs-shim.yaml Outdated
Comment thread .github/workflows/docs-shim.yaml Outdated
Comment thread .github/workflows/docs-shim.yaml
@chance-coleman chance-coleman merged commit 03419f8 into main Mar 26, 2026
26 checks passed
@chance-coleman chance-coleman deleted the chance/core-441-uds-cli-docs-shim branch March 26, 2026 13:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants