ci: document the full validation gate for contributors - #93
Merged
Conversation
The full validation gate runs on every pull request, but CONTRIBUTING.md never mentioned it, so contributors had no way to learn what CI enforces or how to read a failure. Closes #55. Co-Authored-By: Claude <noreply@anthropic.com>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
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
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
The full validation gate is already checked in at
.github/workflows/ci.ymland running on every pull request and push tomain, butCONTRIBUTING.mdnever mentioned it — the one acceptance criterion from #55 that was still outstanding.No workflow behaviour is changed; this documents what is already there.
Existing workflow, verified against the issue
mainand pushes tomainon.pull_request/on.push.branchesNODE_VERSION: 22,PNPM_VERSION: 11.7.0, matching rootenginesandpackageManagerpnpm install --frozen-lockfilelint,typecheck,build,format:check,testQuality gatejobactions/setup-nodewithcache: pnpm, plus a Turbo cachepermissions: contents: readconcurrencykeyed on PR number or ref,cancel-in-progress: trueQuality gate,Trusted runtime and security, and threeLocal runtimechecks on #87, and the checks on this PRThe actions are pinned by commit SHA, and the gate is wider than the issue asked for: it also runs the trusted-runtime security suite and a Windows/macOS/Linux local-runtime matrix.
Coordination with #45
#87 changes what
format:checkenumerates. It does not change the script name, so the workflow needs no edit; the new section states the rule that keeps that true in future.Validation
pnpm format:checkCloses #55.
🤖 Generated with Claude Code