Skip to content

fix(ci): skip docs-only changes for ci and CodeQL workflows #141

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
seonghobae merged 1 commit into from
Sep 3, 2026
Merged

fix(ci): skip docs-only changes for ci and CodeQL workflows #141

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions .github/workflows/ci.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,13 @@ name: ci
on:
push:
branches: [main]
paths-ignore:
- "docs/**"
- "*.md"
Comment on lines +6 to +8

@devin-ai-integration devin-ai-integration Bot Sep 3, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

🟡 Documentation contracts lose validation

When a pull request changes only contract documents, paths-ignore suppresses the sole job validating their invariants. Broken documentation contracts can merge undetected.

Prompt for agents 
The CI workflow contains tests/test_documentation_contract.py, which validates files covered by docs/** and *.md. The pull_request and push paths-ignore filters now suppress that test precisely when a documentation-only change can break those contracts. Keep CodeQL skipped for documentation-only changes, but preserve a lightweight documentation-contract check for those changes. This can be done by narrowing the CI exclusion, splitting documentation validation into a separate workflow/job with appropriate path triggers, or otherwise ensuring the contract test runs on documentation-only pull requests and pushes.
Devin Review

Was this helpful? React with 👍 or 👎 to provide feedback.

@devin-ai-integration devin-ai-integration Bot Sep 3, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

🟡 Nested documentation still triggers workflows

Markdown outside the root and docs/ does not match *.md. Deployment and service guide changes still launch both workflows.

Prompt for agents 
Both .github/workflows/ci.yml and .github/workflows/codeql.yml use *.md, which does not cover nested Markdown guides such as deploy/keycloak/README.md, deploy/templates/README.md, and services/account_unification/README.md. Use a recursive Markdown glob in every filter intended to skip all documentation. Account for the separate documentation-contract requirement in ci.yml rather than suppressing that validation.
Devin Review

Was this helpful? React with 👍 or 👎 to provide feedback.

pull_request:
paths-ignore:
- "docs/**"
- "*.md"
Comment on lines +6 to +12

@devin-ai-integration devin-ai-integration Bot Sep 3, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

🔍 Exact-head policy needs reconciliation

Documentation-only heads no longer receive local CI or CodeQL evidence. Repository guidance still presents both as universal exact-head gates.

Devin Review

Was this helpful? React with 👍 or 👎 to provide feedback.


# Cancel superseded evidence for the same pull request or branch. This keeps the
# runner queue bounded during review-fix loops while preserving the newest head.
Expand Down
6 changes: 6 additions & 0 deletions .github/workflows/codeql.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,13 @@ name: CodeQL
on:
push:
branches: [main]
paths-ignore:
- "docs/**"
- "*.md"
pull_request:
paths-ignore:
- "docs/**"
- "*.md"

# Code scanning evidence is head-specific; cancel scans made obsolete by a
# newer commit on the same pull request or branch.
Expand Down
Loading