Review settings
Documentation Index
Fetch the complete documentation index at: https://docs.sourcery.ai/llms.txt
Use this file to discover all available pages before exploring further.
Review Settings controls what Sourcery posts on a pull request and which pull requests it reviews. It sets the defaults for every repository, and Repo settings overrides them for one.
What a review posts
Section titled “What a review posts”Enable Sourcery on pull requests is the top-level switch. Turn it off and Sourcery posts nothing on a repository’s pull requests. The rest are independent of each other.
| Toggle | What it posts |
|---|---|
| Enable AI review comments | The inline comments and the review body. |
| Enable pull request summary | The summary in the pull request description. |
| Enable review guide | The reviewer’s guide comment. |
| Enable sequence diagrams | Sequence diagrams in the reviewer’s guide. |
| Enable tips and commands | The tips comment that lists chat commands. |
Which pull requests get reviewed
Section titled “Which pull requests get reviewed”Filters narrow which pull requests Sourcery reviews. An empty filter adds no restriction of its own, so Sourcery applies its default behavior.
| Filter | What it does |
|---|---|
| Ignore title keywords | Skips a pull request whose title contains any listed keyword. |
| Labels | An allowlist. When set, Sourcery reviews only pull requests carrying one of the labels. |
| Base branches | An allowlist of regular expressions matched against the base branch. |
| Review draft pull requests | Turns on reviews for drafts, which are skipped by default. |
| Path Filters | A single glob list on the General tab that excludes matching files from the reviewed diff. |
Review language
Section titled “Review language”Sourcery writes reviews in English by default, but it can write in many others. The language applies to the summary, the reviewer’s guide, and the inline comments.
Pick a language from the Select language dropdown on the General tab. The change applies to reviews from then on. Open the dropdown for the current list.
Settings for one repository
Section titled “Settings for one repository”Settings apply at two scopes. Organization defaults cover every repository, and a repository can override them.
A repository follows the organization defaults while its Use Organization Settings toggle is on. Turn the toggle off to edit that repository on its own. Turning it back on and applying restores the organization defaults and discards the repository’s own settings. There is no separate revert action.
-
Open the repository's settings
Open Repo settings and pick the repository you want to change.
-
Turn off Use Organization Settings
The form unlocks, pre-filled with the organization defaults as a starting point.
-
Edit and apply
Change the settings for this repository and apply. If you change your mind later, turn Use Organization Settings back on and apply to go back to the organization defaults.