Skip to content

docs(config): document shipped review.effort_score and changed_files_summary toggles #3714

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
loopover-orb merged 1 commit into from
Jul 6, 2026
+18 −4
Merged

docs(config): document shipped review.effort_score and changed_files_summary toggles #3714

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
7 changes: 5 additions & 2 deletions .gittensory.yml.example
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -390,9 +390,12 @@ review:
# Default: 0 (no cap). (#2065)
# max_files: 25

# Planned display toggle (#2069): when enabled, the unified review comment includes a
# `review effort: N/5 (~M min)` line derived from the per-PR effort estimate.
# Unified-comment display toggles (#1957 / #1955 / #2069). Bool | null. Default: null/false — byte-identical.
# Only take effect when the `features.unifiedComment` feature is enabled.
# changed_files_summary: false
# When true, the unified review comment gains a deterministic "Changed files" summary table.
# effort_score: false
# When true, the unified review comment gains a compact "review effort: N/5 (~M min)" chip.

# Deterministic label suggestions (#2045). Each rule SUGGESTS a non-scoring label when a PR matches ALL of the
# `when` criteria it sets (at least one is required): when_paths (any changed path matches a glob), title_contains,
Expand Down
7 changes: 5 additions & 2 deletions config/examples/gittensory.full.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -403,9 +403,12 @@ review:
# Default: 0 (no cap). (#2065)
# max_files: 25

# Planned display toggle (#2069): when enabled, the unified review comment includes a
# `review effort: N/5 (~M min)` line derived from the per-PR effort estimate.
# Unified-comment display toggles (#1957 / #1955 / #2069). Bool | null. Default: null/false — byte-identical.
# Only take effect when the `features.unifiedComment` feature is enabled.
# changed_files_summary: false
# When true, the unified review comment gains a deterministic "Changed files" summary table.
# effort_score: false
# When true, the unified review comment gains a compact "review effort: N/5 (~M min)" chip.

# Deterministic label suggestions (#2045). Each rule SUGGESTS a non-scoring label when a PR matches ALL of the
# `when` criteria it sets (at least one is required): when_paths (any changed path matches a glob), title_contains,
Expand Down
8 changes: 8 additions & 0 deletions test/unit/config-templates.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,14 @@ describe("config/examples review templates (#1682)", () => {
expect(full).not.toMatch(/not parsed yet/);
});

it("documents shipped unified-comment display toggles in gittensory.full.yml (#2069)", () => {
const full = readConfigExample("gittensory.full.yml");
for (const field of ["changed_files_summary", "effort_score"]) {
expect(full, `missing review field ${field}`).toMatch(new RegExp(`# ${field}:`));
}
expect(full).not.toMatch(/Planned display toggle/);
});

it("parses gittensory.minimal.yml with zero warnings and enables no agent actions", () => {
const manifest = parseFocusManifestContent(readConfigExample("gittensory.minimal.yml"), "repo_file");
expect(manifest.warnings).toEqual([]);
Expand Down
Loading