diff --git a/apps/gittensory-ui/src/routes/docs.github-app.tsx b/apps/gittensory-ui/src/routes/docs.github-app.tsx index 76f4a43ee..a7f5a1dfd 100644 --- a/apps/gittensory-ui/src/routes/docs.github-app.tsx +++ b/apps/gittensory-ui/src/routes/docs.github-app.tsx @@ -145,11 +145,14 @@ GET /v1/installations/:id/repair`}
The gittensory app publishes its review as check runs.{" "}
- Gittensory Orb Review Agent is the gate result;{" "}
- Gittensory Context is the advisory companion. Both are controlled per repo
- by checkRunMode (off / enabled), with{" "}
- checkRunDetailLevel choosing minimal, standard, or{" "}
- deep output.
+ Gittensory Orb Review Agent is the gate result, controlled by{" "}
+ reviewCheckMode (required / visible /{" "}
+ disabled). Gittensory Context is the separate advisory
+ companion, controlled by its own checkRunMode (off /{" "}
+ enabled) — these two switches are independent axes, not one setting for both
+ checks. checkRunDetailLevel (minimal / standard) only
+ affects Gittensory Context's output depth; it has no effect on the Orb
+ Review Agent check.
Gittensory Context is advisory and should not be required in branch diff --git a/apps/gittensory-ui/src/routes/docs.how-reviews-work.tsx b/apps/gittensory-ui/src/routes/docs.how-reviews-work.tsx index 962686d7d..976468106 100644 --- a/apps/gittensory-ui/src/routes/docs.how-reviews-work.tsx +++ b/apps/gittensory-ui/src/routes/docs.how-reviews-work.tsx @@ -295,11 +295,12 @@ function HowReviewsWork() {
- The check run can carry the same signals at adjustable depth: checkRunMode (
- off / enabled) publishes the{" "}
- Gittensory Orb Review Agent check, and checkRunDetailLevel (
- minimal / standard / deep) sets how much the check
- summary spells out.
+ The check run can carry the same signals at adjustable depth — but this is the{" "}
+ Gittensory Context check, not the Orb Review Agent gate check:{" "}
+ checkRunMode (off / enabled) publishes it, and{" "}
+ checkRunDetailLevel (minimal / standard) sets how
+ much the check summary spells out. Gittensory Orb Review Agent is published
+ separately, controlled by reviewCheckMode (see above).
publicSignalLevel — minimal / standard (default).
checkRunMode — check-run publishing: off (default) /{" "}
- enabled. Pair with checkRunDetailLevel (minimal{" "}
- (default) / standard / deep).
+ checkRunMode — publishes the Gittensory Context check (not
+ the Orb Review Agent gate check, which is reviewCheckMode):{" "}
+ off (default) / enabled. Pair with{" "}
+ checkRunDetailLevel (minimal (default) / standard).
publicSurface — off / comment_and_label (default) /{" "}
diff --git a/src/review/repo-profile.ts b/src/review/repo-profile.ts
index b6bb1e5d1..a1a7c006c 100644
--- a/src/review/repo-profile.ts
+++ b/src/review/repo-profile.ts
@@ -55,10 +55,12 @@ export type RepoProfileCommands = {
};
export type RepoProfileContributionWorkflow = {
- /** Whether the review gate publishes a check at all, derived from `settings.reviewCheckMode` -- the actual
- * runtime authority for check publication (#2852); `gateCheckMode`/`checkRunMode` are legacy fields kept
- * only for API/back-compat display and no longer drive this decision. Reuses the EXISTING settings
- * resolver rather than re-deriving gate presence from raw repo files. */
+ /** Whether the review gate (the "Gittensory Orb Review Agent" check) publishes a check at all, derived
+ * from `settings.reviewCheckMode` -- the actual runtime authority for that check's publication (#2852).
+ * `gateCheckMode` is a genuinely legacy, deprecated read-back field (#4618) kept only for API/back-compat
+ * display and no longer drives anything. `checkRunMode` is NOT legacy -- it's a live, independent field
+ * that governs the SEPARATE "Gittensory Context" check, unrelated to this one. Reuses the EXISTING
+ * settings resolver rather than re-deriving gate presence from raw repo files. */
gatePublishesCheck: boolean;
linkedIssuePolicy: "required" | "preferred" | "optional";
requireLinkedIssue: boolean;
diff --git a/src/types.ts b/src/types.ts
index 866922e3f..9c1d3f1bd 100644
--- a/src/types.ts
+++ b/src/types.ts
@@ -706,6 +706,11 @@ export type RepositorySettings = {
commentMode: "off" | "detected_contributors_only" | "all_prs";
publicAudienceMode: "oss_maintainer" | "gittensor_only";
publicSignalLevel: "minimal" | "standard";
+ /** Publishes the SEPARATE, always-advisory "Gittensory Context" check-run (#2691) -- entirely independent
+ * of {@link reviewCheckMode}, which governs the "Gittensory Orb Review Agent" gate check. Despite the
+ * similar name and shape, this is NOT a sibling/legacy-alias of reviewCheckMode; the two checks are
+ * different check-runs with different controlling fields (a mismatch already caused real doc drift --
+ * see the disambiguation in README's "Check-run and comment surfaces" section). */
checkRunMode: "off" | "enabled";
// #4620: "deep" removed -- it was never wired to any different behavior than "standard" (formatCheckRunOutput
// and buildCheckRunAnnotations in rules/advisory.ts both branch only on `=== "minimal"` vs not).