From 1293e1ae8334177f7bf9ca869a0aea5f885d9325 Mon Sep 17 00:00:00 2001 From: JSONbored <49853598+JSONbored@users.noreply.github.com> Date: Sun, 12 Jul 2026 06:21:57 -0700 Subject: [PATCH 1/2] docs(review): fix docs pages that describe checkRunMode/reviewCheckMode backwards Two shipped docs pages misattributed which field controls which check-run: docs.how-reviews-work.tsx claimed checkRunMode publishes "Gittensory Orb Review Agent" (it publishes "Gittensory Context" instead), and docs.github-app.tsx claimed both checks are controlled by checkRunMode, self-contradicting its own correct statement two sections later that reviewCheckMode is the gate's authority. Also scopes repo-profile.ts's "legacy" comment to gateCheckMode only (checkRunMode is live, not legacy), adds a JSDoc to checkRunMode cross-referencing reviewCheckMode, and removes the stale "deep" checkRunDetailLevel option from three docs pages (the type was narrowed to minimal|standard in #4620). Refs #5283 --- apps/gittensory-ui/src/routes/docs.github-app.tsx | 13 ++++++++----- .../src/routes/docs.how-reviews-work.tsx | 11 ++++++----- apps/gittensory-ui/src/routes/docs.tuning.tsx | 8 +++++--- src/review/repo-profile.ts | 10 ++++++---- src/types.ts | 5 +++++ 5 files changed, 30 insertions(+), 17 deletions(-) diff --git a/apps/gittensory-ui/src/routes/docs.github-app.tsx b/apps/gittensory-ui/src/routes/docs.github-app.tsx index 76f4a43ee..6d42f22ac 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`}

Checks

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..b0ab2be3d 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).

Putting it together

diff --git a/apps/gittensory-ui/src/routes/docs.tuning.tsx b/apps/gittensory-ui/src/routes/docs.tuning.tsx index a503943a5..e77fa03df 100644 --- a/apps/gittensory-ui/src/routes/docs.tuning.tsx +++ b/apps/gittensory-ui/src/routes/docs.tuning.tsx @@ -472,9 +472,11 @@ function Tuning() { 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). From 10417c9ad66b0000fdc237c4dc119adebf82e22b Mon Sep 17 00:00:00 2001 From: JSONbored <49853598+JSONbored@users.noreply.github.com> Date: Sun, 12 Jul 2026 06:31:29 -0700 Subject: [PATCH 2/2] fix(ui): prettier formatting for the checkRunMode doc fix CI's ui:lint caught formatting the earlier commit's editor didn't apply. No content change, whitespace/wrapping only. --- apps/gittensory-ui/src/routes/docs.github-app.tsx | 6 +++--- apps/gittensory-ui/src/routes/docs.how-reviews-work.tsx | 4 ++-- apps/gittensory-ui/src/routes/docs.tuning.tsx | 9 ++++----- 3 files changed, 9 insertions(+), 10 deletions(-) diff --git a/apps/gittensory-ui/src/routes/docs.github-app.tsx b/apps/gittensory-ui/src/routes/docs.github-app.tsx index 6d42f22ac..a7f5a1dfd 100644 --- a/apps/gittensory-ui/src/routes/docs.github-app.tsx +++ b/apps/gittensory-ui/src/routes/docs.github-app.tsx @@ -150,9 +150,9 @@ GET /v1/installations/:id/repair`} 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. + 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 b0ab2be3d..976468106 100644 --- a/apps/gittensory-ui/src/routes/docs.how-reviews-work.tsx +++ b/apps/gittensory-ui/src/routes/docs.how-reviews-work.tsx @@ -299,8 +299,8 @@ function HowReviewsWork() { 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). + much the check summary spells out. Gittensory Orb Review Agent is published + separately, controlled by reviewCheckMode (see above).

    Putting it together

    diff --git a/apps/gittensory-ui/src/routes/docs.tuning.tsx b/apps/gittensory-ui/src/routes/docs.tuning.tsx index e77fa03df..d5d68b88d 100644 --- a/apps/gittensory-ui/src/routes/docs.tuning.tsx +++ b/apps/gittensory-ui/src/routes/docs.tuning.tsx @@ -472,11 +472,10 @@ function Tuning() { publicSignalLevel — minimal / standard (default).
  • - 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). + 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) /{" "}