Skip to content

ci: add docs build check on pull requests - #35

Merged
zurfjereluhmie merged 1 commit into
mainfrom
ci/docs-build-check
Apr 22, 2026
Merged

ci: add docs build check on pull requests#35
zurfjereluhmie merged 1 commit into
mainfrom
ci/docs-build-check

Conversation

@zurfjereluhmie

@zurfjereluhmie zurfjereluhmie commented Apr 22, 2026

Copy link
Copy Markdown
Owner
  • Adds a docs-check job to CI that runs mkdocs build --clean --strict as a dry run on pull requests
  • Uses dorny/paths-filter@v4 to only trigger when docs-related files change (docs/, mkdocs.yml, src/, .github/workflows/docs.yml)
  • The ci-success gate job now includes docs-check in its dependency list with allowed-skips so it does not block PRs that don't touch documentation
  • Catches syntax errors, missing references, and broken docs before they hit main

How it works

  1. On every PR, the docs-check job runs and checks if any docs-related files changed
  2. If yes: installs dependencies and runs mkdocs build --strict (fails on warnings)
  3. If no: the job is skipped and ci-success allows it via allowed-skips

Add a docs-check job to CI that runs mkdocs build --strict as a dry
run when docs-related files change (docs/, mkdocs.yml, src/, or the
docs workflow itself). Uses dorny/paths-filter to skip the job when
no relevant files are modified.

The ci-success gate job now includes docs-check with allowed-skips
so it does not block PRs that do not touch documentation.
@zurfjereluhmie
zurfjereluhmie merged commit f868c52 into main Apr 22, 2026
9 checks passed
@zurfjereluhmie
zurfjereluhmie deleted the ci/docs-build-check branch April 22, 2026 12:34
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.

1 participant