ci: add docs build check on pull requests - #35
Merged
Conversation
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.
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.
docs-checkjob to CI that runsmkdocs build --clean --strictas a dry run on pull requestsdorny/paths-filter@v4to only trigger when docs-related files change (docs/,mkdocs.yml,src/,.github/workflows/docs.yml)ci-successgate job now includesdocs-checkin its dependency list withallowed-skipsso it does not block PRs that don't touch documentationHow it works
docs-checkjob runs and checks if any docs-related files changedmkdocs build --strict(fails on warnings)ci-successallows it viaallowed-skips