BadAtCaptchasandJannis Braun
1e6c7c6042
Makes local dev work on Windows: cross-env for the server dev port, pnpm --parallel to run server+web together (replacing the POSIX-only '&'), PowerShell setup docs, engines widened to Node >=20, and a Node 20 + 24 CI matrix. CI keeps a stable required 'Build & test' status via an aggregate gate job so the matrix rename doesn't drop the context the main ruleset requires. Co-authored-by: BadAtCaptchas <2359196+BadAtCaptchas@users.noreply.github.com> Co-authored-by: Jannis Braun <151788261+TheZwiss@users.noreply.github.com>
88 lines
3.1 KiB
YAML
88 lines
3.1 KiB
YAML
name: CI
|
|
|
|
# Runs the workspace's typecheck, production build, and full test suite on every
|
|
# pull request and on pushes to main. Purpose: catch compile errors and test
|
|
# regressions before merge instead of relying on each contributor running tests
|
|
# locally. Once this check is green on a PR, enable branch protection on `main`
|
|
# ("Require status checks to pass" → select "Build & test") to make it blocking.
|
|
|
|
on:
|
|
pull_request:
|
|
push:
|
|
branches: [main]
|
|
|
|
permissions:
|
|
contents: read
|
|
|
|
# A newer commit on the same branch/PR supersedes in-flight runs — cancel the
|
|
# stale one so a rapid push sequence doesn't queue redundant CI.
|
|
concurrency:
|
|
group: ci-${{ github.ref }}
|
|
cancel-in-progress: true
|
|
|
|
jobs:
|
|
build-and-test:
|
|
name: Build & test (Node ${{ matrix.node-version }})
|
|
runs-on: ubuntu-latest
|
|
|
|
strategy:
|
|
fail-fast: false
|
|
matrix:
|
|
node-version: [20, 24]
|
|
|
|
steps:
|
|
- name: Checkout
|
|
uses: actions/checkout@v5
|
|
|
|
- name: Setup pnpm
|
|
uses: pnpm/action-setup@v5
|
|
with:
|
|
version: 10.34.3
|
|
- name: Setup Node.js
|
|
uses: actions/setup-node@v5
|
|
with:
|
|
node-version: ${{ matrix.node-version }}
|
|
cache: pnpm
|
|
|
|
# The desktop postinstall tries to rebuild the native uiohook-napi module.
|
|
# It fails gracefully (|| warn) without X11 dev headers, and nothing in CI
|
|
# needs the native binary — the desktop tests and TS compile are pure JS —
|
|
# so we intentionally skip installing those headers to keep CI fast.
|
|
- name: Install dependencies
|
|
run: pnpm install --frozen-lockfile
|
|
|
|
# Compiles shared → server → web (each runs tsc; web also runs the Vite
|
|
# production build). This is the typecheck + build gate for those three.
|
|
- name: Build shared, server & web
|
|
run: pnpm build
|
|
|
|
# Desktop is not part of `pnpm build` (that produces an Electron installer,
|
|
# which release.yml owns). Type-check its source here so desktop TS errors
|
|
# surface on PRs rather than only at release-tag time.
|
|
- name: Typecheck desktop
|
|
run: pnpm --filter @backspace/desktop build:ts
|
|
|
|
# Runs every package's `test` script (server, web, desktop) via vitest.
|
|
- name: Test
|
|
run: pnpm -r test
|
|
|
|
# Aggregate gate reporting a single, matrix-independent "Build & test" status.
|
|
# Branch protection on main requires the "Build & test" context, but the matrix
|
|
# job above reports per-version contexts ("Build & test (Node 20/24)"). This job
|
|
# keeps the stable required context alive and fails unless every matrix leg
|
|
# succeeded (if: always() so a matrix failure still reports a definitive result
|
|
# instead of leaving the required check pending forever).
|
|
build-and-test-required:
|
|
name: Build & test
|
|
if: always()
|
|
needs: build-and-test
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- name: Verify matrix result
|
|
run: |
|
|
if [ "${{ needs.build-and-test.result }}" != "success" ]; then
|
|
echo "Matrix build-and-test did not succeed: ${{ needs.build-and-test.result }}"
|
|
exit 1
|
|
fi
|
|
echo "All matrix legs passed."
|