Local Ci

Local CI

Use the local CI runner and Turbo/package scripts as the source of truth for validation in this repo.

Quick Start

1. Start with the smallest deterministic check that matches the change. 2. Prefer pnpm run ci:local --only=<job> for CI-parity validation. 3. Prefer direct Turbo or package scripts only when they are the smaller equivalent of the CI job. 4. Report exactly which command ran, what failed first, and which expected checks were skipped.

Workflow

1. Inspect available local CI jobs

Run:

pnpm run ci:local --list

Use this when the right job is unclear or when the repo may have added or renamed jobs.

For the current job map, read references/jobs.md.

2. Pick the smallest matching job

Use these defaults:

• Package code in packages/*: start with build-and-test only if the change is broad; otherwise prefer package build/test commands.
• Metro packages or Metro workflow changes: use build-metro, then Metro E2E jobs only if relevant.
• E2E app changes: run the matching e2e-* job instead of build-and-test.
• Devtools workflow or Playwright/devtools changes: run devtools.
• Bundle-size workflow/reporting changes: run bundle-size.
• GitHub workflow syntax only: use actionlint locally only to see skip behavior; the actual action is CI-only.
• Broad CI, packaging, publint, Turbo, or shared runtime changes: run build-and-test.

3. Run commands in CI order

When reproducing CI, use the same command shape as the repo:

pnpm run ci:local --only=build-and-test
pnpm run ci:local --only=devtools
pnpm run ci:local --only=e2e-runtime

To run more than one job:

pnpm run ci:local --only=build-and-test,bundle-size

4. Interpret failures correctly

• Treat the first failing step as the actionable failure.
• Ignore known noisy warnings unless they exit non-zero.
• Distinguish repo-wide drift from changed-file gates.
• If ci:local fails in Check code format, inspect the changed-file formatter result before running broader builds.
• If a dependency build outside the touched scope fails, note it separately as an unrelated blocker.

Common Cases

Broad package or runtime/plugin change

Run:

pnpm run ci:local --only=build-and-test

If that fails on format first, fix the changed files before rerunning the whole job.

One package only

Prefer the smaller direct command first:

pnpm exec turbo run build --filter=@module-federation/<pkg>
pnpm exec turbo run test --filter=@module-federation/<pkg> --force

Then run build-and-test only if the user asks for CI parity or the package change affects shared build/runtime behavior.

E2E change

Run the matching job from references/jobs.md, not the whole matrix.

Workflow change

Use the local CI job if one exists for the workflow's behavior. For workflow syntax, pair local validation with the repo's actionlint path when relevant.

Notes

• ci:local sets CI=true and mirrors the repo workflow order.
• Some jobs intentionally skip GitHub-only actions such as actionlint and bundle-size-comment.
• The repo uses pnpm, Node 20, and Turbo as the standard execution path.
• In worktrees, still use Turbo/package scripts directly as documented by the repo instructions.

Local CI job map

Use pnpm run ci:local --list if you need to refresh this list from the repo.

Core jobs

• build-and-test
• Full package-oriented CI parity job.
• Includes install, Cypress install, changed-file format check, Turbo/publint verification, package build, and affected package tests.
• Use for shared runtime, plugin, CI, packaging, publint, or broad package changes.

• build-metro
• Metro-specific parity job.
• Use for packages/metro* and related Metro workflow changes.

• bundle-size
• Bundle-size measurement workflow parity.
• Use for bundle-size collection or reporting logic.

• devtools
• Devtools workflow parity job.
• Use for packages/chrome-devtools, Playwright/devtools setup, and devtools workflow changes.

E2E jobs

• e2e-modern
• e2e-runtime
• e2e-manifest
• e2e-node
• e2e-next-dev
• e2e-next-prod
• e2e-treeshake
• e2e-modern-ssr
• e2e-router
• metro-affected-check
• metro-android-e2e
• metro-ios-e2e
• e2e-shared-tree-shaking

Use the smallest job that matches the app/runtime surface you changed.

CI-only local skips

• actionlint
• Listed for parity, but skipped because the GitHub-only action does not fully execute locally.

• bundle-size-comment
• Listed for parity, but skipped locally because it depends on GitHub workflow-run artifacts.

Helpful commands

List jobs:

pnpm run ci:local --list

Run one job:

pnpm run ci:local --only=build-and-test

Run multiple jobs:

pnpm run ci:local --only=build-and-test,bundle-size

Run a smaller non-ci:local package check:

pnpm exec turbo run build --filter=@module-federation/<pkg>
pnpm exec turbo run test --filter=@module-federation/<pkg> --force