Skip to content

docs(electron): document CI workflows and the merge gate#378

Open
danshapiro wants to merge 1 commit into
mainfrom
docs/ci-merge-gate-note
Open

docs(electron): document CI workflows and the merge gate#378
danshapiro wants to merge 1 commit into
mainfrom
docs/ci-merge-gate-note

Conversation

@danshapiro
Copy link
Copy Markdown
Owner

Summary

Adds a Continuous integration and the merge gate section to docs/development/windows-electron-build.md.

It documents the two relevant GitHub Actions workflows and which one actually gates merges:

  • Typecheck Client (typecheck-client.yml) — npm run typecheck:client on every PR / push to main; the only required status check in the main ruleset.
  • Electron Build (electron-build.yml) — full npm test + npm run electron:build on the macOS/Ubuntu/Windows matrix, triggered on v* tags and electron-path PRs; informational, not merge-blocking.

This captures knowledge that's otherwise invisible (the branch ruleset config) directly in repo docs where every agent can see it.

Testing

Doc-only change — no code or tests affected. typecheck-client (the sole required check) is unaffected by markdown.

🤖 Generated with Claude Code

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) <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants