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

GitHub App instructions

Browse Source
This commit is contained in:
mrT23
2023-08-30 19:46:33 +03:00
parent 307b3b4bf7
commit ad6dd38fe3
1 changed files with 4 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
CONFIGURATION.md
View File

@ -25,7 +25,7 @@ This is useful for debugging or experimenting with the different tools.
When running PR-Agent from GitHub App, the default configuration file (`configuration.toml`) will be loaded. When running PR-Agent from GitHub App, the default configuration file (`configuration.toml`) will be loaded.
#### GitHub app default tools #### GitHub app default tools
The GitHub app configuration is defined in the `[github_app]` section of the configuration file. The GitHub app specific configurations are defined in the `[github_app]` section of the configuration file.
The main parameter is `pr_commands`, which is a list of tools to run when a new PR is opened: The main parameter is `pr_commands`, which is a list of tools to run when a new PR is opened:
``` ```
[github_app] [github_app]
@ -37,7 +37,7 @@ pr_commands = [
This means that when a new PR is opened, PR-Agent will run the `describe` and `auto_review` tools. This means that when a new PR is opened, PR-Agent will run the `describe` and `auto_review` tools.
For the describe tool, the `add_original_user_description` and `keep_original_user_title` parameters will be set to `true`. For the describe tool, the `add_original_user_description` and `keep_original_user_title` parameters will be set to `true`.
However, you can override the default actions parameters by uploading a local configuration called `.pr_agent.toml`, to the root of your repo. However, you can override the default tool parameters by uploading a local configuration called `.pr_agent.toml`, to the root of your repo.
For example, if your local `.pr_agent.toml` file contains: For example, if your local `.pr_agent.toml` file contains:
``` ```
[pr_description] [pr_description]
@ -46,6 +46,8 @@ keep_original_user_title = false
``` ```
Then when a new PR is opened, PR-Agent will run the `describe` tool with the above parameters. Then when a new PR is opened, PR-Agent will run the `describe` tool with the above parameters.
Note that a local `.pr_agent.toml` file enables you to edit and customize the default parameters of any tool, not just the ones that are run by default.
#### Online usage #### Online usage
For online usage (calling tools by comments on a PR), just add `--config_path=<value>` to any command, to edit a specific configuration value. For online usage (calling tools by comments on a PR), just add `--config_path=<value>` to any command, to edit a specific configuration value.
For example if you want to edit `pr_reviewer` configurations, you can run: For example if you want to edit `pr_reviewer` configurations, you can run: