-
Notifications
You must be signed in to change notification settings - Fork 79
ci: per-app build matrix with precise path triggers #1112
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.
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
Open
msluszniak
wants to merge
19
commits into
main
Choose a base branch
from
@ms/ci-coverage
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
19 commits
Select commit
Hold shift + click to select a range
6e4cdb9
ci: add per-app build matrix with precise path triggers
msluszniak 471403f
ci: compact path filters with brace expansion
msluszniak 12385c0
ci: build workspace packages before running bare-rn jest
msluszniak ecbf706
ci: merge Android + iOS workflows into one with single filter block
msluszniak dd34770
test(bare-rn): mock native packages so smoke test can render
msluszniak c9d2a9f
ci: use generic iOS Simulator destination so build doesn't need a spe…
msluszniak 2c68b80
ci: add Metro bundle check matrix to catch JS errors before native build
msluszniak d1af2ed
ci: fail lint when source files aren't covered by build-apps filter
msluszniak 9aef7d0
ci: skip already-passing app builds via content-hash cache marker
msluszniak dbb8737
ci: bare-rn bundle prep, Pods cache, exclude workflow file from build…
msluszniak cfcd199
ci: rewrite filter-coverage and app-hash scripts in TypeScript
msluszniak bb64376
ci: cover pose_estimation and privacy_filter in build-apps filters
msluszniak cf4fdb9
ci: address review — dedupe prepare step, pin Pods cache to v5, justi…
msluszniak 0dd4cba
ci: save caches against branch ref so PR close/reopen doesn't wipe them
msluszniak edf42ab
Revert "ci: save caches against branch ref so PR close/reopen doesn't…
msluszniak 32be6ef
ci: narrow dorny diff to current push + drop oversized peer caches
msluszniak a0bcf39
ci: replace dorny with custom git-diff step (push-incremental for pul…
msluszniak 8c02351
docs(ci): add README explaining the per-app build matrix
msluszniak 144b77b
test(bare-rn): mock models registry so post-#1148 App.tsx renders
msluszniak File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,114 @@ | ||
| name: Build Android app | ||
| description: Build an Android demo app from this monorepo (with optional Expo prebuild) | ||
|
|
||
| inputs: | ||
| app-path: | ||
| description: Path to the app workspace, relative to the repo root (e.g. apps/llm) | ||
| required: true | ||
| expo-prebuild: | ||
| description: Whether to run `expo prebuild --platform android` before the Gradle build | ||
| required: false | ||
| default: "true" | ||
| filter-name: | ||
| description: dorny/paths-filter filter name for this app+platform (e.g. llm-android). Used as the content-hash cache key so a previously-passing build can be skipped if nothing relevant has changed. | ||
| required: true | ||
|
|
||
| runs: | ||
| using: composite | ||
| steps: | ||
| - name: Setup Node.js | ||
| uses: actions/setup-node@v6 | ||
| with: | ||
| node-version-file: .nvmrc | ||
| cache: "yarn" | ||
|
|
||
| - name: Install root dependencies | ||
| shell: bash | ||
| run: yarn install --immutable | ||
|
|
||
| - name: Compute build hash | ||
| id: hash | ||
| shell: bash | ||
| run: | | ||
| h=$(npx ts-node scripts/compute-app-hash.ts "${{ inputs.filter-name }}") | ||
| echo "key=build-${{ inputs.filter-name }}-$h" >> "$GITHUB_OUTPUT" | ||
|
|
||
| - name: Lookup pass marker | ||
| id: cache | ||
| uses: actions/cache/restore@v4 | ||
| with: | ||
| path: ${{ runner.temp }}/ci-marker | ||
| key: ${{ steps.hash.outputs.key }} | ||
| lookup-only: true | ||
|
|
||
| - name: Skip notice | ||
| if: steps.cache.outputs.cache-hit == 'true' | ||
| shell: bash | ||
| run: echo "Skipping build — ${{ inputs.filter-name }} already passed at this content hash." | ||
|
|
||
| # ubuntu-latest ships with ~14 GB free, but a full Android build for any of | ||
| # the demo apps (Gradle cache + ExecuTorch native build + node_modules + | ||
| # third-party libs) regularly exceeds that and fails with "no space left on | ||
| # device". Reclaim ~10 GB by removing toolchains we don't use here. | ||
| - name: Free disk space | ||
| if: steps.cache.outputs.cache-hit != 'true' | ||
| shell: bash | ||
| run: | | ||
| sudo rm -rf /usr/share/dotnet | ||
| sudo rm -rf /opt/ghc | ||
| sudo rm -rf /opt/hostedtoolcache/CodeQL | ||
| sudo docker system prune -af | ||
|
|
||
| - name: Setup Java 17 | ||
| if: steps.cache.outputs.cache-hit != 'true' | ||
| uses: actions/setup-java@v5 | ||
| with: | ||
| distribution: "zulu" | ||
| java-version: 17 | ||
|
|
||
| - name: Install Expo CLI | ||
| if: steps.cache.outputs.cache-hit != 'true' && inputs.expo-prebuild == 'true' | ||
| shell: bash | ||
| run: | | ||
| npm install -g @expo/cli | ||
| echo "$(npm prefix -g)/bin" >> $GITHUB_PATH | ||
|
|
||
| - name: Generate native Android project | ||
| if: steps.cache.outputs.cache-hit != 'true' && inputs.expo-prebuild == 'true' | ||
| working-directory: ${{ inputs.app-path }} | ||
| shell: bash | ||
| run: | | ||
| rm -rf android | ||
| npx expo prebuild --platform android --no-install | ||
|
|
||
| # Note: not caching ~/.gradle or apps/<app>/android/.gradle on purpose. | ||
| # A full Gradle cache for this monorepo runs ~3 GB and competes with the | ||
| # 10 GB repo cache quota against the much smaller (~250 B) build markers. | ||
| # Markers gating entire build cells beat ~5-10 min of Gradle warm-up. | ||
| - name: Build app | ||
| if: steps.cache.outputs.cache-hit != 'true' | ||
| working-directory: ${{ inputs.app-path }}/android | ||
| shell: bash | ||
| run: | | ||
| ./gradlew assembleDebug \ | ||
| --build-cache \ | ||
| --parallel \ | ||
| --daemon \ | ||
| --configure-on-demand \ | ||
| -PreactNativeArchitectures=arm64-v8a \ | ||
| -Dorg.gradle.jvmargs="-Xmx4g -XX:+HeapDumpOnOutOfMemoryError" \ | ||
| -Dorg.gradle.workers.max=4 | ||
|
|
||
| - name: Save pass marker | ||
| if: steps.cache.outputs.cache-hit != 'true' && success() | ||
| shell: bash | ||
| run: | | ||
| mkdir -p "${{ runner.temp }}/ci-marker" | ||
| touch "${{ runner.temp }}/ci-marker/passed" | ||
|
|
||
| - name: Cache pass marker | ||
| if: steps.cache.outputs.cache-hit != 'true' && success() | ||
| uses: actions/cache/save@v4 | ||
| with: | ||
| path: ${{ runner.temp }}/ci-marker | ||
| key: ${{ steps.hash.outputs.key }} | ||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,111 @@ | ||
| name: Build iOS app | ||
| description: Build an iOS demo app from this monorepo (with optional Expo prebuild) | ||
|
|
||
| inputs: | ||
| app-path: | ||
| description: Path to the app workspace, relative to the repo root (e.g. apps/llm) | ||
| required: true | ||
| expo-prebuild: | ||
| description: Whether to run `expo prebuild --platform ios` before pod install | ||
| required: false | ||
| default: "true" | ||
| filter-name: | ||
| description: dorny/paths-filter filter name for this app+platform (e.g. llm-ios). Used as the content-hash cache key so a previously-passing build can be skipped if nothing relevant has changed. | ||
| required: true | ||
|
|
||
| runs: | ||
| using: composite | ||
| steps: | ||
| - name: Setup Node.js | ||
| uses: actions/setup-node@v6 | ||
| with: | ||
| node-version-file: .nvmrc | ||
| cache: "yarn" | ||
|
|
||
| - name: Install root dependencies | ||
| shell: bash | ||
| run: yarn install --immutable | ||
|
|
||
| - name: Compute build hash | ||
| id: hash | ||
| shell: bash | ||
| run: | | ||
| h=$(npx ts-node scripts/compute-app-hash.ts "${{ inputs.filter-name }}") | ||
| echo "key=build-${{ inputs.filter-name }}-$h" >> "$GITHUB_OUTPUT" | ||
|
|
||
| - name: Lookup pass marker | ||
| id: cache | ||
| uses: actions/cache/restore@v4 | ||
| with: | ||
| path: ${{ runner.temp }}/ci-marker | ||
| key: ${{ steps.hash.outputs.key }} | ||
| lookup-only: true | ||
|
|
||
| - name: Skip notice | ||
| if: steps.cache.outputs.cache-hit == 'true' | ||
| shell: bash | ||
| run: echo "Skipping build — ${{ inputs.filter-name }} already passed at this content hash." | ||
|
|
||
| - name: Setup Xcode | ||
| if: steps.cache.outputs.cache-hit != 'true' | ||
| uses: maxim-lobanov/setup-xcode@v1 | ||
| with: | ||
| xcode-version: latest-stable | ||
|
|
||
| - name: Install Expo CLI | ||
| if: steps.cache.outputs.cache-hit != 'true' && inputs.expo-prebuild == 'true' | ||
| shell: bash | ||
| run: | | ||
| npm install -g @expo/cli | ||
| echo "$(npm prefix -g)/bin" >> $GITHUB_PATH | ||
|
|
||
| - name: Generate native iOS project | ||
| if: steps.cache.outputs.cache-hit != 'true' && inputs.expo-prebuild == 'true' | ||
| working-directory: ${{ inputs.app-path }} | ||
| shell: bash | ||
| run: | | ||
| rm -rf ios | ||
| npx expo prebuild --platform ios --no-install | ||
|
|
||
| # Note: not caching CocoaPods on purpose. A populated Pods/ runs ~500 MB | ||
| # per app — ~2.5 GB across the 5 iOS cells — and competes with the 10 GB | ||
| # repo cache quota against the much smaller (~250 B) build markers. | ||
| # Markers gating entire build cells beat ~3-5 min of pod-install warm-up. | ||
| - name: Install CocoaPods dependencies | ||
| if: steps.cache.outputs.cache-hit != 'true' | ||
| working-directory: ${{ inputs.app-path }}/ios | ||
| shell: bash | ||
| run: pod install | ||
|
|
||
| - name: Build app | ||
| if: steps.cache.outputs.cache-hit != 'true' | ||
| working-directory: ${{ inputs.app-path }}/ios | ||
| shell: bash | ||
| run: | | ||
| WORKSPACE=$(ls -d *.xcworkspace | head -n 1) | ||
| SCHEME="${WORKSPACE%.xcworkspace}" | ||
| set -o pipefail && xcodebuild \ | ||
| -workspace "$WORKSPACE" \ | ||
| -scheme "$SCHEME" \ | ||
| -sdk iphonesimulator \ | ||
| -configuration Debug \ | ||
| -destination 'generic/platform=iOS Simulator' \ | ||
| build \ | ||
| CODE_SIGNING_ALLOWED=NO \ | ||
| -jobs $(sysctl -n hw.ncpu) \ | ||
| COMPILER_INDEX_STORE_ENABLE=NO \ | ||
| ONLY_ACTIVE_ARCH=YES | xcbeautify | ||
|
|
||
| - name: Save pass marker | ||
| if: steps.cache.outputs.cache-hit != 'true' && success() | ||
| shell: bash | ||
| run: | | ||
| mkdir -p "${{ runner.temp }}/ci-marker" | ||
| touch "${{ runner.temp }}/ci-marker/passed" | ||
|
|
||
| - name: Cache pass marker | ||
| if: steps.cache.outputs.cache-hit != 'true' && success() | ||
| uses: actions/cache/save@v4 | ||
| with: | ||
| path: ${{ runner.temp }}/ci-marker | ||
| key: ${{ steps.hash.outputs.key }} |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,130 @@ | ||
| # CI workflows | ||
|
|
||
| Three GitHub Actions workflows run on every PR: | ||
|
|
||
| | Workflow | Jobs | | ||
| |---|---| | ||
| | [`ci.yml`](ci.yml) | `lint` (eslint + `check-ci-filter-coverage.ts` + typecheck) and `build-library` (`yarn workspaces ... prepare`). Skips markdown / docs-only changes via `paths-ignore`. | | ||
| | [`test-bare-rn.yml`](test-bare-rn.yml) | Jest smoke test for `apps/bare-rn` | | ||
| | [`build-apps.yml`](build-apps.yml) | Per-app build matrix — bundles + native builds for all 5 demo apps on Android + iOS | | ||
|
|
||
| All three workflows skip draft PRs via `if: github.event.pull_request.draft != true`. `build-apps.yml` and `test-bare-rn.yml` additionally short-circuit on forks (`github.repository == 'software-mansion/react-native-executorch'`) so the expensive native matrix doesn't run on contributor forks. | ||
|
|
||
| The rest of this README explains `build-apps.yml`, which is the expensive one and has the most moving parts. | ||
|
|
||
| ## The per-app build matrix | ||
|
|
||
| A naive matrix runs ~20 min × 10 native cells × every push. Two layers cut that cost: | ||
|
|
||
| 1. **Path filtering** narrows the matrix per push — only apps whose files actually changed enter the matrix. | ||
| 2. **Content-hash cache markers** let cells that already passed for the current code skip the build entirely. | ||
|
|
||
| Both layers read the same filter file: [`scripts/build-app-filters.yml`](../../scripts/build-app-filters.yml). | ||
|
|
||
| ``` | ||
| push → detect-changes job → matrix of (app, platform) cells | ||
| │ │ | ||
| │ └─ each cell: compute content hash → cache lookup → skip if marker exists | ||
| │ | ||
| └─ git diff $before $head | matched against build-app-filters.yml | ||
| ``` | ||
|
|
||
| ## Filter file: `scripts/build-app-filters.yml` | ||
|
|
||
| Single source of truth for "which files belong to which app". Uses YAML anchors so each path is named once and composed up: | ||
|
|
||
| ```yaml | ||
| core-shared: &core-shared # files every app depends on | ||
| - packages/react-native-executorch/src/{common,constants,errors,native,types,utils}/** | ||
| - "{package.json,yarn.lock}" | ||
| # ... | ||
| android-shared: &android-shared # Android-only shared | ||
| - .github/actions/build-android-app/** | ||
| - packages/react-native-executorch/android/** | ||
| cv-pkg: &cv-pkg # CV-specific TS modules + C++ models | ||
| - packages/react-native-executorch/common/rnexecutorch/models/VisionModel.{cpp,h} | ||
| - packages/react-native-executorch/common/rnexecutorch/models/{classification,...,vertical_ocr}/** | ||
| - packages/react-native-executorch/src/{modules,hooks}/computer_vision/** | ||
| # ... | ||
| computer-vision-app: &computer-vision-app | ||
| - *core-shared | ||
| - *expo-fetcher | ||
| - *cv-pkg | ||
| - apps/computer-vision/** | ||
| computer-vision-android: [*computer-vision-app, *android-shared] | ||
| computer-vision-ios: [*computer-vision-app, *ios-shared] | ||
| ``` | ||
|
|
||
| The final `<app>-<platform>` entries are what the matrix consumes. Everything else is composition. | ||
|
|
||
| ### When to update the filter file | ||
|
|
||
| | Change | Update | | ||
| |---|---| | ||
| | New file under `apps/<existing-app>/**` | Nothing — already covered by `<app>-app` | | ||
| | New model directory under `packages/react-native-executorch/common/rnexecutorch/models/<domain>/` | `<domain>-pkg` anchor (add the directory name into its brace-expansion list) | | ||
| | New TS module under `src/modules/<domain>/` or `src/hooks/<domain>/` | `<domain>-pkg` anchor | | ||
| | New file that affects every app (e.g. new utility under `src/common/`) | Usually already covered by `core-shared`'s `src/{common,constants,errors,native,types,utils}/**` | | ||
| | New iOS-only / Android-only source under `packages/react-native-executorch/ios/` or `/android/` | Already covered by `ios-shared` / `android-shared` (broad `**` globs) | | ||
| | New demo app under `apps/<new-app>/` | New `<new-app>-pkg` + `<new-app>-app` + `<new-app>-android` + `<new-app>-ios` anchors, plus the apps list in `build-apps.yml`'s `Compute matrices` step | | ||
|
|
||
| You don't have to remember this list. `scripts/check-ci-filter-coverage.ts` runs in `ci.yml`'s `lint` job and fails the PR if any file under `packages/react-native-executorch/` isn't matched by a filter — you'll get a list of orphans and which anchor to add them to. | ||
|
|
||
| If a file genuinely doesn't belong to any build (e.g. `tsconfig.doc.json`), add it to `ALLOWLIST` in that script instead. | ||
|
|
||
| ## Push-incremental diff (instead of `dorny/paths-filter`) | ||
|
|
||
| `dorny/paths-filter@v3` silently ignores its `base:` input on `pull_request` events (you'll see `'base' input parameter is ignored when action is triggered by pull request event` in the log). It always uses GitHub's PR-files API, which returns the *cumulative* PR diff — so every push to a PR re-evaluates filters against the entire PR diff and pulls every app that has ever been touched into the matrix. | ||
|
|
||
| We replaced it with [`scripts/detect-changed-filters.ts`](../../scripts/detect-changed-filters.ts), which runs `git diff --name-only $base $head` and matches the result against `build-app-filters.yml` using picomatch. For `pull_request synchronize` events, `base` is `github.event.before` (the previous push SHA), so the diff is just what *this push* changed. For `opened` / `reopened` / `ready_for_review`, `github.event.before` isn't set and the script falls back to `pull_request.base.sha` (full PR diff — the right thing for those events). | ||
|
|
||
| ## Cache markers | ||
|
|
||
| Even when a cell enters the matrix, [`compute-app-hash.ts`](../../scripts/compute-app-hash.ts) hashes every tracked file matched by that cell's filter (excluding `HASH_EXCLUDE`). The hash becomes a cache key: `build-<app>-<platform>-<hash>` (or `bundle-<platform>-<app>-<hash>` for the bundle job). If a marker with that key exists in the GitHub Actions cache, the cell exits before doing any real work. | ||
|
|
||
| Markers are tiny (~250 bytes each — they exist only as cache-presence proofs, no payload). They're saved at the end of every successful build and live under the per-PR ref (`refs/pull/N/merge`) plus `refs/heads/main` for main-branch builds. | ||
|
|
||
| ### `HASH_EXCLUDE` | ||
|
|
||
| Editing a file in `core-shared` triggers every app's matrix cell, but most edits to those files don't actually change build behavior — workflow tweaks, filter-file edits, etc. The hash excludes a small allowlist of orchestration files so editing them re-runs the matrix but every cell still hits its existing marker: | ||
|
|
||
| ```ts | ||
| // compute-app-hash.ts | ||
| const HASH_EXCLUDE = new Set([ | ||
| '.github/workflows/build-apps.yml', | ||
| 'scripts/build-app-filters.yml', | ||
| 'scripts/detect-changed-filters.ts', | ||
| ]); | ||
| ``` | ||
|
|
||
| If you make a workflow edit that *does* change build behavior — pinning a new action version, changing a `with:` input on a composite, swapping `runs-on:`, editing `.github/actions/setup/` (Node version, install flags) — markers won't reflect it. Force-clear the relevant cache entries from **Actions → Caches** in the repo UI. | ||
|
|
||
| Edits inside the per-platform composite actions (`.github/actions/build-android-app/`, `.github/actions/build-ios-app/`) *do* invalidate markers automatically, because those paths are part of `android-shared` / `ios-shared` and contribute to the hash. | ||
|
|
||
| ## Common scenarios | ||
|
|
||
| ### "I pushed a one-line tweak to one app and CI fired everything" | ||
|
|
||
| It shouldn't — push-incremental diff narrows to just that app's filter. If it didn't, check: | ||
|
|
||
| - Did the tweak also touch a file in `core-shared`? `package.json`, `yarn.lock`, and anything under `packages/react-native-executorch/src/{common,constants,errors,native,types,utils}/` fan out to every app. | ||
| - Is this the first push to a fresh PR? `pull_request opened` uses the PR base for the diff, which is correct but means the *entire PR diff* matches filters on the first run. Subsequent `synchronize` pushes will narrow. | ||
|
|
||
| ### "I edited build-apps.yml and now everything is rebuilding from scratch" | ||
|
|
||
| `build-apps.yml` is in `HASH_EXCLUDE`, so cells should fan out but hit cache. If they're rebuilding for real: | ||
|
|
||
| - Did you also change something else under `core-shared` in the same push? That would invalidate every hash. | ||
| - Did the markers get evicted? GitHub's cache quota is 10 GB per repo with LRU eviction. Markers themselves are tiny but the yarn `node_modules` cache (~550 MB × Linux + macOS) sits alongside them. Heavy churn on other branches can evict markers. | ||
|
|
||
| ### "I want to force a full rebuild" | ||
|
|
||
| **Actions → Caches** in the repo UI. Filter by `build-` or `bundle-` prefix and delete the relevant entries. Next push will cache-miss and rebuild. | ||
|
|
||
| ### "I added a new model directory and the lint job fails saying it's an orphan" | ||
|
|
||
| `scripts/check-ci-filter-coverage.ts` walks every tracked file under `packages/react-native-executorch/` and verifies it matches at least one filter. Fix by adding the new path to the right `<domain>-pkg` anchor in `scripts/build-app-filters.yml`. If the file genuinely doesn't belong to any build (it's a doc, a license, etc.), add it to `ALLOWLIST` in `check-ci-filter-coverage.ts`. | ||
|
|
||
| ### "I'm working on a long-running branch and don't want CI on every push" | ||
|
|
||
| Open the PR in draft. All three workflows skip on `draft != true`. Marking the PR as ready_for_review fires the workflows fresh on the current HEAD. |
Oops, something went wrong.
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.