Skip to content

fix: use dorny/paths-filter so required checks pass on docs-only PRs #427

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
lwshang merged 2 commits into from
Mar 12, 2026
+92 −48
Merged

fix: use dorny/paths-filter so required checks pass on docs-only PRs #427

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d421450
fix: use dorny/paths-filter so required checks pass on docs-only PRs
lwshang Mar 12, 2026
ae1154f
fix: add comment explaining why test job checks discover's result
lwshang Mar 12, 2026
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
50 changes: 32 additions & 18 deletions .github/workflows/checks.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,25 +4,33 @@ on:
push:
branches:
- main
paths-ignore:
# NOTE: docs/reference/cli.md is auto-generated and ideally should trigger
# the cli-ref check when manually edited. However, GitHub Actions does not
# support combining paths-ignore with negation patterns, so we accept the
# tradeoff: manual edits to that file won't be caught in isolation, but
# will be caught the next time any Rust source is changed and the checks run.
- "**.md"
- "docs-site/**"
- "npm/**"
pull_request:
paths-ignore:
# See push paths-ignore NOTE above for the tradeoff explanation.
- "**.md"
- "docs-site/**"
- "npm/**"

jobs:
changes:
runs-on: ubuntu-latest
outputs:
src: ${{ steps.filter.outputs.src }}
permissions:
pull-requests: read
steps:
- uses: actions/checkout@08eba0b27e820071cde6df949e0beb9ba4906955 # v4.3.0
- uses: dorny/paths-filter@de90cc6fb38fc0963ad72b210f1f284cd68cea36 # v3.0.2
id: filter
with:
# 'src' is true when any changed file matches a positive pattern
# and does not match a negative pattern (! prefix).
filters: |
src:
- '**'
- '!**.md'
- '!docs-site/**'
- '!npm/**'
compile:
name: compile:required
needs: changes
if: needs.changes.outputs.src == 'true'
runs-on: ubuntu-latest

steps:
Expand All @@ -42,7 +50,8 @@ jobs:

lint:
name: lint:required
needs: compile # Run after compilation to use the cache
needs: [changes, compile]
if: needs.changes.outputs.src == 'true'
runs-on: ubuntu-latest

steps:
Expand All @@ -62,7 +71,8 @@ jobs:

format:
name: fmt:required
needs: compile
needs: [changes, compile]
if: needs.changes.outputs.src == 'true'
runs-on: ubuntu-latest

steps:
Expand All @@ -80,6 +90,8 @@ jobs:

toml-format:
name: toml-fmt:required
needs: changes
if: needs.changes.outputs.src == 'true'
runs-on: ubuntu-latest

steps:
Expand All @@ -106,7 +118,8 @@ jobs:
# generate the CLI reference file and check if it is up to date
#
name: cli-ref:required
needs: compile
needs: [changes, compile]
if: needs.changes.outputs.src == 'true'
runs-on: ubuntu-latest

steps:
Expand Down Expand Up @@ -140,7 +153,8 @@ jobs:
# generate config schemas and check if they are up to date
#
name: icp-yaml-schema:required
needs: compile
needs: [changes, compile]
if: needs.changes.outputs.src == 'true'
runs-on: ubuntu-latest

steps:
Expand Down
49 changes: 35 additions & 14 deletions .github/workflows/test.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,7 @@ on:
push:
branches:
- main
paths-ignore:
- "**.md"
- "docs/**"
- "docs-site/**"
- "npm/**"
pull_request:
paths-ignore:
- "**.md"
- "docs/**"
- "docs-site/**"
- "npm/**"

env:
# When getting Rust dependencies, retry on network error:
Expand All @@ -31,7 +21,30 @@ defaults:
shell: bash

jobs:
changes:
runs-on: ubuntu-latest
outputs:
src: ${{ steps.filter.outputs.src }}
permissions:
pull-requests: read
steps:
- uses: actions/checkout@08eba0b27e820071cde6df949e0beb9ba4906955 # v4.3.0
- uses: dorny/paths-filter@de90cc6fb38fc0963ad72b210f1f284cd68cea36 # v3.0.2
id: filter
with:
# 'src' is true when any changed file matches a positive pattern
# and does not match a negative pattern (! prefix).
filters: |
src:
- '**'
- '!**.md'
- '!docs/**'
- '!docs-site/**'
- '!npm/**'
discover:
needs: changes
if: needs.changes.outputs.src == 'true'
runs-on: ubuntu-latest
outputs:
matrix: ${{ steps.set-matrix.outputs.matrix }}
Expand All @@ -42,6 +55,8 @@ jobs:

unit-tests:
name: Unit tests on ${{ matrix.os }}
needs: changes
if: needs.changes.outputs.src == 'true'
runs-on: ${{ matrix.os }}

strategy:
Expand Down Expand Up @@ -71,6 +86,9 @@ jobs:
name: ${{ matrix.test }} on ${{ matrix.os }}
# Wait until unit tests have run so we can reuse the cache
needs: [discover, unit-tests]
# Check discover's result (not changes.outputs.src) because this job
# needs discover's matrix output, which is only available when it ran.
if: needs.discover.result == 'success'
Copy link
Contributor

@adamspofford-dfinity adamspofford-dfinity Mar 12, 2026

Choose a reason for hiding this comment

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

Why's this one different?

Copy link
Contributor Author

@lwshang lwshang Mar 12, 2026

Choose a reason for hiding this comment

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

Added an inline comment explaining why: this job needs discover's matrix output (via fromJson), which is only available when discover actually ran — so we check its result rather than changes.outputs.src.

runs-on: ${{ matrix.os }}
strategy:
fail-fast: false
Expand Down Expand Up @@ -144,10 +162,13 @@ jobs:

aggregate:
name: test:required
if: ${{ always() }}
if: always() && needs.changes.outputs.src == 'true'
runs-on: ubuntu-latest
needs: [unit-tests, test]
needs: [changes, unit-tests, test]
steps:
- name: check result
if: ${{ needs.unit-tests.result != 'success' || needs.test.result != 'success' }}
- name: check unit-tests result
if: ${{ needs.unit-tests.result != 'success' }}
run: exit 1
- name: check test result
if: ${{ needs.test.result != 'success' }}
run: exit 1
41 changes: 25 additions & 16 deletions .github/workflows/validate-examples.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,20 +4,7 @@ on:
push:
branches:
- main
paths-ignore:
# NOTE: all docs/ markdown files are covered by "**.md" above. The only
# docs/ files that still trigger this workflow are docs/schemas/*.json —
# intentionally, since this workflow validates project manifests against
# those schemas.
- "**.md"
- "docs-site/**"
- "npm/**"
pull_request:
paths-ignore:
# See push paths-ignore NOTE above.
- "**.md"
- "docs-site/**"
- "npm/**"

env:
# When getting Rust dependencies, retry on network error:
Expand All @@ -26,8 +13,30 @@ env:
CURL_HOME: .

jobs:
changes:
runs-on: ubuntu-latest
outputs:
src: ${{ steps.filter.outputs.src }}
permissions:
pull-requests: read
steps:
- uses: actions/checkout@08eba0b27e820071cde6df949e0beb9ba4906955 # v4.3.0
- uses: dorny/paths-filter@de90cc6fb38fc0963ad72b210f1f284cd68cea36 # v3.0.2
id: filter
with:
# 'src' is true when any changed file matches a positive pattern
# and does not match a negative pattern (! prefix).
filters: |
src:
- '**'
- '!**.md'
- '!docs-site/**'
- '!npm/**'

validate-examples:
name: Validate Examples on ${{ matrix.os }}
needs: changes
if: needs.changes.outputs.src == 'true'
runs-on: ${{ matrix.os }}

strategy:
Expand All @@ -54,10 +63,10 @@ jobs:

aggregate:
name: validate-examples:required
if: ${{ always() }}
if: always() && needs.changes.outputs.src == 'true'
runs-on: ubuntu-latest
needs: [validate-examples]
needs: [changes, validate-examples]
steps:
- name: check result
- name: check validate-examples result
if: ${{ needs.validate-examples.result != 'success' }}
run: exit 1
Loading