Skip to content

feat(scripts): widen docs-drift checker to the full config surface #4682

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
JSONbored merged 1 commit into from
Jul 10, 2026
Merged

feat(scripts): widen docs-drift checker to the full config surface #4682

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions .gittensory.yml.example
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1009,11 +1009,22 @@ settings:
# claude_effort: null # Overrides CLAUDE_AI_EFFORT for this repo. String or null. Default (env unset): medium.
# codex_model: null # Overrides CODEX_AI_MODEL for this repo. String or null.
# codex_effort: null # Overrides CODEX_AI_EFFORT for this repo. String or null. Default (env unset): medium.
# ollama_model: null # Overrides OLLAMA_AI_MODEL for this repo's ollama reviewer. String or null. (#3902)
# openai_model: null # Overrides OPENAI_AI_MODEL for this repo's openai reviewer. String or null. (#3902)
# openai_compatible_model: null # Overrides OPENAI_COMPATIBLE_AI_MODEL for this repo. String or null. (#3902)
# anthropic_model: null # Overrides ANTHROPIC_AI_MODEL for this repo's BYOK Messages API reviewer. String or null. (#3902)
# # Per-repo before/after screenshot-capture config (#3609 preview / #3610 routes). Only takes effect when
# # the operator has ALSO enabled GITTENSORY_REVIEW_SCREENSHOTS + this repo's cutover allowlist -- this
# # config narrows/redirects that feature, it never turns it on by itself. All-null/empty/default ⇒
# # byte-identical to today (GitHub-native preview discovery, automatic file-to-route inference).
# visual:
# # The repo's "before" production URL -- e.g. "https://metagraph.sh" for a repo whose live site differs
# # from the operator's own PUBLIC_SITE_ORIGIN env var (a single GLOBAL value with no per-repo awareness,
# # correct for at most one repo on a multi-repo self-host instance). ALWAYS wins over PUBLIC_SITE_ORIGIN
# # when set, mirroring preview.url_template's precedence over GitHub-native discovery below. Must resolve
# # to a valid HTTPS URL targeting a public host (same SSRF guard as preview.url_template). String or null.
# # Default: null (falls back to PUBLIC_SITE_ORIGIN).
# production_url: "https://example.com"
# preview:
# # The repo's "after" preview URL, with {number}/{head_sha}/{head_sha_short} placeholders substituted
# # at capture time. ALWAYS wins over GitHub-native preview discovery (Deployments API / commit checks /
Expand Down
11 changes: 11 additions & 0 deletions config/examples/gittensory.full.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1022,11 +1022,22 @@ settings:
# claude_effort: null # Overrides CLAUDE_AI_EFFORT for this repo. String or null. Default (env unset): medium.
# codex_model: null # Overrides CODEX_AI_MODEL for this repo. String or null.
# codex_effort: null # Overrides CODEX_AI_EFFORT for this repo. String or null. Default (env unset): medium.
# ollama_model: null # Overrides OLLAMA_AI_MODEL for this repo's ollama reviewer. String or null. (#3902)
# openai_model: null # Overrides OPENAI_AI_MODEL for this repo's openai reviewer. String or null. (#3902)
# openai_compatible_model: null # Overrides OPENAI_COMPATIBLE_AI_MODEL for this repo. String or null. (#3902)
# anthropic_model: null # Overrides ANTHROPIC_AI_MODEL for this repo's BYOK Messages API reviewer. String or null. (#3902)
# # Per-repo before/after screenshot-capture config (#3609 preview / #3610 routes). Only takes effect when
# # the operator has ALSO enabled GITTENSORY_REVIEW_SCREENSHOTS + this repo's cutover allowlist -- this
# # config narrows/redirects that feature, it never turns it on by itself. All-null/empty/default ⇒
# # byte-identical to today (GitHub-native preview discovery, automatic file-to-route inference).
# visual:
# # The repo's "before" production URL -- e.g. "https://metagraph.sh" for a repo whose live site differs
# # from the operator's own PUBLIC_SITE_ORIGIN env var (a single GLOBAL value with no per-repo awareness,
# # correct for at most one repo on a multi-repo self-host instance). ALWAYS wins over PUBLIC_SITE_ORIGIN
# # when set, mirroring preview.url_template's precedence over GitHub-native discovery below. Must resolve
# # to a valid HTTPS URL targeting a public host (same SSRF guard as preview.url_template). String or null.
# # Default: null (falls back to PUBLIC_SITE_ORIGIN).
# production_url: "https://example.com"
# preview:
# # The repo's "after" preview URL, with {number}/{head_sha}/{head_sha_short} placeholders substituted
# # at capture time. ALWAYS wins over GitHub-native preview discovery (Deployments API / commit checks /
Expand Down
18 changes: 17 additions & 1 deletion scripts/check-docs-drift.d.mts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,30 @@ export function extractCatalogIds(sourceText: string, catalogConstName: string):

export function extractGateModeFields(typesText: string): string[];

export function extractRepositorySettingsFields(typesText: string): string[];

export function extractFocusManifestFields(focusManifestText: string): string[];

export type GateModeManifestRow = { field: string; aliases: string[]; pages: string[] };

export const GATE_MODE_MANIFEST: GateModeManifestRow[];

export type AliasManifestRow = { field: string; aliases: string[] };

export const SETTINGS_ALIAS_MANIFEST: AliasManifestRow[];

export const FOCUS_MANIFEST_ALIAS_MANIFEST: AliasManifestRow[];

export function checkDocsDrift(options: {
root: string;
readFile?: (root: string, relativePath: string) => string;
}): {
failures: string[];
counts: { flags: number; commands: number; gateModes: number };
counts: {
flags: number;
commands: number;
gateModes: number;
settingsFields: number;
focusManifestFields: number;
};
};
Loading