docs(electron): document CI workflows and the merge gate - #378
Closed
danshapiro wants to merge 1 commit into
Closed
Conversation
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>
Owner
Author
|
Closing as outdated: this doc describes typecheck-client as the only required status check, but the main ruleset now requires three checks (clippy, contract, typecheck-client). Merging would add incorrect documentation. If CI documentation is still wanted, it should be rewritten against the current ruleset. |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
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.yml) —npm run typecheck:clienton every PR / push tomain; the only required status check in themainruleset.electron-build.yml) — fullnpm test+npm run electron:buildon the macOS/Ubuntu/Windows matrix, triggered onv*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