docs(selfhost): clarify checkRunMode duplicates the required gate check - #2742
Merged
Conversation
Document that the checkRunMode advisory check surface is independent of, and largely duplicative with, the required Gittensory Orb Review Agent gate check and the PR comment, so one-shot self-host installs know to leave it at its default off unless they specifically want a second, low-detail check-run surface. Closes #2691
25 tasks
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
investigation confirmed
checkRunModealready defaults tooff, that the advisoryGittensory Contextcheck and the requiredGittensory Orb Review Agentgate check are fully independentwith zero cross-gating, and that at the default
checkRunDetailLevel: minimalthe Context checknever posts findings, while at
standard/deepit only re-renders findings already shown in thegate check and PR comment. The only remaining action item from that comment was documentation:
nothing in
.gittensory.yml.exampleexplained that enablingcheckRunModeadds a second,mostly-redundant check surface once the gate is already on.
checkRunMode: offin.gittensory.yml.exampleexplainingthat it's an independent, legacy advisory surface, distinct from and duplicative of the required
gate check and PR comment, and that one-shot self-host installs should leave it at the default
offunless they specifically want a second, low-detail check-run surface.config/examples/README.md: it is deliberately scoped to the private-configlayering/merge mechanism (precedence chain, deep-merge semantics) and explicitly defers to
.gittensory.yml.exampleas "the exhaustive, field-by-field reference (not duplicated here, sothe two never drift out of sync)." Adding a per-setting cross-reference there would duplicate
content the file intentionally avoids duplicating, so it is left untouched.
Scope
type(scope): short summaryConventional Commit format, for examplefix(api): restore profile access checks.CONTRIBUTING.mdand does not reintroduce GitHub Pages, VitePress,site/, orCNAME.Validation
git diff --checknpm run actionlint(N/A — no workflow files changed; docs-only edit to.gittensory.yml.example)npm run typechecknpm run test:coveragelocally (N/A — nosrc/**lines changed; ran the targeted example-config parse test instead:npx vitest run test/unit/focus-manifest.test.ts -t "gittensory.yml.example", passing, confirming the added comment doesn't break YAML/comment parsing)npm run test:workers(N/A — no worker code changed)npm run build:mcp(N/A — no MCP code changed)npm run test:mcp-pack(N/A — no MCP code changed)npm run ui:openapi:check(N/A — no API/schema changes)npm run ui:lint(N/A — no UI files changed)npm run ui:typecheck(N/A — no UI files changed)npm run ui:build(N/A — no UI files changed)npm audit --audit-level=moderate(N/A — no dependency changes; ran during this session'snpm ciwith 0 vulnerabilities found)If any required check was skipped, explain why:
.gittensory.yml.example), sothe code-oriented checks above (lint/build/coverage/audit/workers/mcp) don't apply. Per the task
scope, the two checks that matter for this change — the example-config parse test and
npm run typecheck— were both run locally and passed.Safety
UI Evidencesection below with JPG/JPEG or PNG screenshots... (N/A — no visible UI change; this is a config-example comment).gittensory.yml.exampleupdated;CHANGELOG.mduntouched)UI Evidence
N/A — no visible UI, frontend, or rendered-docs change; this PR only adds a comment block to
.gittensory.yml.example.Notes