Configure with greptile.json
Configure Greptile settings and patterns per repository
You can have custom settings at the repo level by adding a greptile.json
file to the root of the repo in your default branch.
You can grab your global settings in the correct format here by clicking on the copy
or download
icons on the top right of the Settings panel.
The ignorePatterns
field follows .gitignore
syntax.
greptile.json
Configuration Parameters
Parameter | Type | Description |
---|---|---|
labels | array | Labels that will trigger a Greptile review when added to a PR. In the example above, adding “feature” or “bug” label will trigger a review. |
comment | string | A disclaimer or prefix that will be added to every Greptile PR summary. Useful for compliance requirements. |
commentTypes | array | Types of comments Greptile should make. Options include: “logic”, “syntax”, “security”, “performance”, “style”, “compliance”. |
instructions | string | Natural language custom instructions for Greptile to follow when reviewing code. Can reference files in your repo or contain specific rules. |
ignoreKeywords | string | Newline-separated list of keywords. PRs with these keywords in their title or description will be ignored. |
ignorePatterns | string | Newline-separated list of file patterns to ignore, following .gitignore syntax. Files matching these patterns will not be reviewed. |
patternRepositories | array | List of repositories to learn patterns from. Greptile will analyze these repos to understand your codebase’s patterns. |
triggerOnUpdates | boolean | If true, Greptile will review code every time a PR is updated with a new commit. |
shouldUpdateDescription | boolean | If true, Greptile will update the PR description with a summary of changes. If false, only comments on code. |
disabledLabels | array | PRs with these labels will not be reviewed by Greptile, even if other trigger conditions are met. |
includeAuthors | array | Only PRs from these authors will be reviewed. If empty, reviews PRs from all authors (except excluded ones). |
excludeAuthors | array | PRs from these authors will not be reviewed, even if other trigger conditions are met. |
Was this page helpful?