From d84891104e20d5dc9b1e5c9357c51109401110af Mon Sep 17 00:00:00 2001 From: Codex Date: Sat, 30 May 2026 17:58:23 -0700 Subject: [PATCH] docs(electron): document CI workflows and the merge gate Add a "Continuous integration and the merge gate" section to the Windows Electron build doc, clarifying that only the Typecheck Client workflow is a required status check on main and that the Electron Build macOS/Ubuntu/Windows matrix is informational rather than merge-blocking. Co-Authored-By: Claude Opus 4.8 (1M context) --- docs/development/windows-electron-build.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/docs/development/windows-electron-build.md b/docs/development/windows-electron-build.md index f3190553..7f85c012 100644 --- a/docs/development/windows-electron-build.md +++ b/docs/development/windows-electron-build.md @@ -96,3 +96,24 @@ A good build should show: server runtime — absent in broken cross-builds). - `release/win-unpacked/resources/server-node-modules/node-pty/prebuilds/win32-x64/conpty.node` exists. + +## Continuous integration and the merge gate + +Two GitHub Actions workflows are relevant to this feature: + +- **Typecheck Client** (`.github/workflows/typecheck-client.yml`) runs + `npm run typecheck:client` on Ubuntu for every pull request and every push to + `main`. This is the **only required status check** in the `main` branch + ruleset — it is what gates merging. +- **Electron Build** (`.github/workflows/electron-build.yml`) runs the full + `npm test` suite and `npm run electron:build` on a `macos-latest` / + `ubuntu-latest` / `windows-latest` matrix, uploading the installers as + artifacts. It triggers only on `v*` tags and on pull requests that touch + electron-relevant paths (`electron/**`, `electron-builder.yml`, + `scripts/prepare-bundled-node.ts`, `scripts/bundled-node-version.json`). + +Because the branch ruleset lists only `typecheck-client` as required (with zero +required approvals), the Electron Build matrix is **informational, not +merge-blocking**: a PR can be merged while those jobs are still running or +non-green. Treat the matrix as a cross-platform smoke signal and read its logs +before relying on a build, rather than as a hard gate.