Skip to content

Commit d021b17

Browse files
committed
ci: skip heavy checks for docs-only changes
Add a shared GitHub Actions change detector that treats docs/ and Markdown/MDX updates as documentation-only changes. Use that detector to keep the CI workflow present while skipping lint, tests, native package builds, preview package publishing, E2E, schema generation, and performance comparison jobs when a PR or push only changes documentation. The workflow-level status still exists, avoiding the required-check pending behavior that paths-ignore can cause. The performance comment workflows now use the same detector so docs-only PR updates do not build packages or generate large fixtures just to post benchmark comments.
1 parent 314c803 commit d021b17

4 files changed

Lines changed: 97 additions & 2 deletions

File tree

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
name: Detect code changes
2+
description: Detect whether changed files require full code validation
3+
outputs:
4+
code-changed:
5+
description: Whether any changed file is outside documentation-only paths
6+
value: ${{ steps.detect.outputs.code-changed }}
7+
runs:
8+
using: composite
9+
steps:
10+
- id: detect
11+
shell: bash
12+
env:
13+
BASE_SHA: ${{ github.event.pull_request.base.sha || github.event.before }}
14+
HEAD_SHA: ${{ github.event.pull_request.head.sha || github.sha }}
15+
run: |
16+
set -euo pipefail
17+
18+
base_sha="$BASE_SHA"
19+
head_sha="$HEAD_SHA"
20+
21+
if [[ -z "$base_sha" || "$base_sha" =~ ^0+$ ]]; then
22+
base_sha="$(git rev-list --max-parents=0 "$head_sha")"
23+
fi
24+
25+
if ! git cat-file -e "$base_sha^{commit}" || ! git cat-file -e "$head_sha^{commit}"; then
26+
echo "code-changed=true" >> "$GITHUB_OUTPUT"
27+
exit 0
28+
fi
29+
30+
changed_files="$(mktemp)"
31+
git diff --name-only "$base_sha" "$head_sha" > "$changed_files"
32+
33+
code_changed=false
34+
while IFS= read -r path; do
35+
[[ -z "$path" ]] && continue
36+
37+
case "$path" in
38+
docs/*|*.md|*.mdx) ;;
39+
*) code_changed=true; break ;;
40+
esac
41+
done < "$changed_files"
42+
43+
echo "code-changed=$code_changed" >> "$GITHUB_OUTPUT"

‎.github/workflows/ccusage-perf.yaml‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,21 @@ permissions:
1313
issues: write
1414

1515
jobs:
16+
changes:
17+
name: Detect code changes
18+
runs-on: ubuntu-slim
19+
outputs:
20+
code-changed: ${{ steps.detect.outputs.code-changed }}
21+
steps:
22+
- uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
23+
with:
24+
fetch-depth: 0
25+
- id: detect
26+
uses: ./.github/actions/detect-code-changes
27+
1628
compare:
29+
needs: changes
30+
if: needs.changes.outputs.code-changed == 'true'
1731
runs-on: ubuntu-24.04-arm
1832
timeout-minutes: 30
1933

‎.github/workflows/ccusage-rust-perf.yaml‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,21 @@ permissions:
1313
issues: write
1414

1515
jobs:
16+
changes:
17+
name: Detect code changes
18+
runs-on: ubuntu-slim
19+
outputs:
20+
code-changed: ${{ steps.detect.outputs.code-changed }}
21+
steps:
22+
- uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
23+
with:
24+
fetch-depth: 0
25+
- id: detect
26+
uses: ./.github/actions/detect-code-changes
27+
1628
compare:
29+
needs: changes
30+
if: needs.changes.outputs.code-changed == 'true'
1731
runs-on: ubuntu-24.04-arm
1832
timeout-minutes: 30
1933

‎.github/workflows/ci.yaml‎

Lines changed: 26 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,21 @@ on:
55
pull_request:
66

77
jobs:
8+
changes:
9+
name: Detect code changes
10+
runs-on: ubuntu-slim
11+
outputs:
12+
code-changed: ${{ steps.detect.outputs.code-changed }}
13+
steps:
14+
- uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
15+
with:
16+
fetch-depth: 0
17+
- id: detect
18+
uses: ./.github/actions/detect-code-changes
19+
820
lint-check:
21+
needs: changes
22+
if: needs.changes.outputs.code-changed == 'true'
923
runs-on: ubuntu-24.04-arm
1024

1125
steps:
@@ -15,6 +29,8 @@ jobs:
1529
- run: nix develop --command pnpm typecheck
1630

1731
test:
32+
needs: changes
33+
if: needs.changes.outputs.code-changed == 'true'
1834
runs-on: ubuntu-24.04-arm
1935

2036
steps:
@@ -27,6 +43,8 @@ jobs:
2743
- run: nix develop --command pnpm run test
2844

2945
build-native-packages:
46+
needs: changes
47+
if: needs.changes.outputs.code-changed == 'true'
3048
runs-on: ${{ matrix.os }}
3149
timeout-minutes: 30
3250
strategy:
@@ -105,7 +123,9 @@ jobs:
105123

106124
npm-publish-dry-run-and-upload-pkg-pr-now:
107125
needs:
126+
- changes
108127
- build-native-packages
128+
if: needs.changes.outputs.code-changed == 'true'
109129
runs-on: ubuntu-24.04-arm
110130
outputs:
111131
urls: ${{ steps.publish.outputs.urls }}
@@ -127,8 +147,10 @@ jobs:
127147
run: nix develop --command pnpm pkg-pr-new publish --pnpm --bin './apps/ccusage' './packages/ccusage-*'
128148

129149
ccusage-preview-e2e:
130-
if: github.event_name == 'pull_request'
131-
needs: npm-publish-dry-run-and-upload-pkg-pr-now
150+
if: github.event_name == 'pull_request' && needs.changes.outputs.code-changed == 'true'
151+
needs:
152+
- changes
153+
- npm-publish-dry-run-and-upload-pkg-pr-now
132154
runs-on: ${{ matrix.os }}
133155
timeout-minutes: 20
134156
strategy:
@@ -174,6 +196,8 @@ jobs:
174196
- run: nix develop --command typos --config ./typos.toml
175197

176198
schema-check:
199+
needs: changes
200+
if: needs.changes.outputs.code-changed == 'true'
177201
runs-on: ubuntu-24.04-arm
178202
steps:
179203
- uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2

0 commit comments

Comments
 (0)