xiaxinhang/pr-agent
1
0
Fork 0
mirror of https://github.com/qodo-ai/pr-agent.git synced 2025-07-12 16:50:37 +08:00
Code Issues Packages Projects Releases Wiki Activity

Update usage documentation

Browse Source
This commit is contained in:
jamesrom
2023-10-06 22:13:03 +11:00
parent baa0e95227
commit 6dee18b24a
1 changed files with 22 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
Usage.md
View File

@ -29,6 +29,16 @@ In addition to general configuration options, each tool has its own configuratio
The [Tools Guide](./docs/TOOLS_GUIDE.md) provides a detailed description of the different tools and their configurations.
#### Ignoring files from analysis
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](/pr_agent/settings/ignore.toml)** configuration file. This setting is also exposed the following environment variables:
- `IGNORE.GLOB`
- `IGNORE.REGEX`
See [dynaconf envvars documentation](https://www.dynaconf.com/envvars/).
#### git provider
The [git_provider](pr_agent/settings/configuration.toml#L4) field in the configuration file determines the GIT provider that will be used by PR-Agent. Currently, the following providers are supported:
`