xiaxinhang/pr-agent
1
0
Fork 0
mirror of https://github.com/qodo-ai/pr-agent.git synced 2025-07-06 05:40:38 +08:00
Code Issues Packages Projects Releases Wiki Activity

Update usage guide to clarify ignore settings and provide example usage

Browse Source
This commit is contained in:
mrT23
2024-06-19 13:59:04 +03:00
parent ded8dc3689
commit 47b12d8bbc
1 changed files with 11 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
docs/docs/usage-guide/additional_configurations.md
View File

@ -2,13 +2,20 @@
In some cases, you may want to exclude specific files or directories from the analysis performed by CodiumAI PR-Agent. This can be useful, for example, when you have files that are generated automatically or files that shouldn't be reviewed, like vendored code. In some cases, you may want to exclude specific files or directories from the analysis performed by CodiumAI PR-Agent. This can be useful, for example, when you have files that are generated automatically or files that shouldn't be reviewed, like vendored code.
To ignore files or directories, edit the **[ignore.toml](https://github.com/Codium-ai/pr-agent/blob/main/pr_agent/settings/ignore.toml)** configuration file. This setting also exposes the following environment variables: The default ignore settings are defined in **[ignore.toml](https://github.com/Codium-ai/pr-agent/blob/main/pr_agent/settings/ignore.toml)** configuration file. This setting also exposes the following environment variables:
- `IGNORE.GLOB` - `IGNORE.GLOB`
- `IGNORE.REGEX` - `IGNORE.REGEX`
For example, to ignore Python files in a PR with online usage, comment on a PR: which you can edit to ignore files or folders based on glob or regex patterns.
`/review --ignore.glob=['*.py']`
### Example usage
Let's look at an example where we want to ignore all files with `.py` extension from the analysis.
To ignore Python files in a PR with online usage, comment on a PR:
`/review --ignore.glob="['*.py']"`
To ignore Python files in all PRs using `glob` pattern, set in a configuration file: To ignore Python files in all PRs using `glob` pattern, set in a configuration file:
``` ```
@ -21,6 +28,7 @@ And to ignore Python files in all PRs using `regex` pattern, set in a configurat
[regex] [regex]
regex = ['.*\.py$'] regex = ['.*\.py$']
``` ```
## Extra instructions ## Extra instructions
All PR-Agent tools have a parameter called `extra_instructions`, that enables to add free-text extra instructions. Example usage: All PR-Agent tools have a parameter called `extra_instructions`, that enables to add free-text extra instructions. Example usage: