Summary Configuration
The Summary settings control automated PR and MR summary generation per repository. Access them from your Optibot dashboard at agents.getoptimal.ai → configuration tab → Summary section. Toggle settings from the form view or edit directly in the raw JSON panel.
Auto Summary
Setting: Auto summary Type: boolean Default: On
Enables or disables automatic summary generation when a new PR or MR is opened. Optibot summaries cover the functional aspects of the code changes in detail, plus a collapsible file-by-file breakdown.
When to use:
-
Keep on for automatic summaries on all PRs — helps reviewers understand changes at a glance and can often replace the need to write a PR description manually
-
Turn off if summaries should only be generated on request, or if you have specific PR description requirements that summaries would conflict with
Auto Summary on Draft
Setting: Auto summary on draft Type: boolean Default: On
Controls whether Optibot generates summaries on PRs and MRs that are in draft state. By default, Optibot will summarize draft PRs when they are opened. Turn this off if you want Optibot to wait until the PR is marked "Ready to review" on GitHub (or equivalent on GitLab) before generating a summary.
When to use: Turn off when your draft PRs are genuinely work-in-progress and you expect to push more changes before anyone should be reviewing or reading a summary.
Summary Level
Setting: Summary level Type: string — Short / Basic / Detailed Default: Basic
Controls the depth of detail Optibot includes in generated summaries.
Short A concise 2–3 sentence natural-language overview of the pull request. Ideal for quick updates that don't interrupt workflow, or when reviewers only need a high-level read.
Example output:
Updates login flow to streamline authentication and add basic validation. Cleans up unused logic and prepares the service for upcoming enhancements.
Basic A brief overview of changes, key modifications, and an impact summary. Works well for small, atomic PRs that require quick reviews.
Example output:
This PR adds user authentication middleware and updates the login endpoint. Key Changes: 2 new files, 3 modified files, ~150 lines changed.
Detailed A comprehensive analysis with file-by-file breakdown, architectural impact notes, and testing recommendations. Best for large PRs, complex features, and critical changes.
Example output:
This PR implements JWT-based authentication middleware with refresh token support.
Files Changed:
src/middleware/auth.ts(new): JWT verification middleware with role-based access control
src/routes/auth.ts(modified): Added refresh token endpoint
src/utils/token.ts(new): Token generation and validation utilitiesImpact Analysis:
Security: Implements industry-standard JWT authentication
Performance: Adds ~10ms latency per authenticated request
Testing: Requires new integration tests for auth flows
Dependencies: Added
[email protected]and[email protected]
When to use:
-
Use Short for fast-moving teams or when summaries are supplementary to existing PR descriptions
-
Use Basic for most teams — the right balance of context without overwhelming reviewers
-
Use Detailed for large codebases, complex features, or any PR where architectural context matters
Excluded Labels
Setting: Excluded labels Type: array of strings Default: Empty
Prevents Optibot from generating summaries on PRs or MRs that carry any of the specified labels. Labels are case-sensitive and must be an exact match.
When to use:
-
Skip summaries for trivial or minor changes
-
Exclude documentation-only PRs
-
Bypass summaries for automated dependency updates
Examples:
Skip trivial changes:
trivial, typo-fix, formatting
Exclude docs and dependencies:
documentation, dependencies
Note: Use exact label names as they appear in GitHub or GitLab — both are case-sensitive.
Excluded Users
Setting: Excluded users Type: array of strings Default: Empty
Prevents Optibot from generating summaries on PRs or MRs opened by specified usernames. Especially useful when bot accounts regularly open automated PRs that don't need a summary.
When to use:
-
Exclude bot accounts that create automated PRs (Dependabot, Renovate, localization bots)
-
Skip summaries for specific team members if needed
Examples:
Exclude common bots:
dependabot, renovate[bot], l10n-bot
Note: Use the exact username as it appears on GitHub or GitLab, including any [bot] suffix where applicable.
Note: All settings are per-repository. Configure each connected repository separately from the repository selector at the top of the Settings tab. Changes take effect immediately for new PRs and MRs — no commits or deployments required.