Skip CI Jobs on Documentation-Only Changes
Add path filters so jobs that compile or test code are skipped when the diff touches only markdown and docs.
Task
Automate git diff --name-only origin/main...HEAD | grep -vE '\.(md|mdx|png)$' || echo 'docs-only' so pipeline failures are caught before merge and never reach production.
When to use this
A pull request merges with a broken git diff --name-only origin/main...HEAD | grep -vE '\.(md|mdx|png)$' || echo 'docs-only' step because the workflow did not gate on it, causing a failed deploy.
Prerequisites
- Node.js 22 and pnpm available
- A CI workflow file in .github/workflows
Steps
1. Configure git diff --name-only origin/main...HEAD | grep -vE '\.(md|mdx|png)$' || echo 'docs-only' in the project configuration file with the recommended defaults.
git diff --name-only origin/main...HEAD | grep -vE '\.(md|mdx|png)$' || echo 'docs-only'
Expected output: The configuration is accepted and git diff --name-only origin/main...HEAD | grep -vE '\.(md|mdx|png)$' || echo 'docs-only' runs without errors on the first invocation.
2. Run the check locally to verify git diff --name-only origin/main...HEAD | grep -vE '\.(md|mdx|png)$' || echo 'docs-only' produces the expected result before pushing.
pnpm test
Expected output: Local run matches CI behavior; no surprises after push.
3. Add the gate to the CI pipeline so git diff --name-only origin/main...HEAD | grep -vE '\.(md|mdx|png)$' || echo 'docs-only' blocks merge on failure.
- name: Run add conditional job skip
run: pnpm test
Expected output: Pull requests with failing git diff --name-only origin/main...HEAD | grep -vE '\.(md|mdx|png)$' || echo 'docs-only' are blocked from merging.
Troubleshooting
Problem
The check passes locally but fails in CI
Solution
Pin dependency versions and the runtime to match CI exactly; reproduce with the same Docker image or act.
Problem
Configuration is rejected with a schema error
Solution
Check the tool version matches the config schema; older versions may not support newer fields.
Limitations
- The gate only runs on events that trigger the workflow; locally pushed commits bypass it.
- Configuration drift is possible if someone edits settings outside version control.
Gate the pipeline before merge
Start by measuring the problem. Add path filters so jobs that compile or test code are skipped when the diff touches only markdown and docs. The most common mistake is adding the gate without first confirming it catches the issue you care about. Run git diff –name-only origin/main…HEAD | grep -vE ‘.(md|mdx|png)$’ || echo ‘docs-only’ against the current codebase and inspect the output before wiring it into CI.
git diff --name-only origin/main...HEAD | grep -vE '\.(md|mdx|png)$' || echo 'docs-only'Make failures actionable
Once the gate is in place, make failures actionable. A failing git diff –name-only origin/main…HEAD | grep -vE ‘.(md|mdx|png)$’ || echo ‘docs-only’ should point to the exact file and line, not a generic error. Pin the tool version in the lockfile so a upstream release does not silently change behavior. Review the gate output in every pull request just like a test result.