From ad6dd38fe37a7b700eea4ebc5ec8c831f0c61429 Mon Sep 17 00:00:00 2001 From: mrT23 Date: Wed, 30 Aug 2023 19:46:33 +0300 Subject: [PATCH] GitHub App instructions --- CONFIGURATION.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/CONFIGURATION.md b/CONFIGURATION.md index 79f86313..07cc5701 100644 --- a/CONFIGURATION.md +++ b/CONFIGURATION.md @@ -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. #### 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: ``` [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. 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: ``` [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. +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 For online usage (calling tools by comments on a PR), just add `--config_path=` to any command, to edit a specific configuration value. For example if you want to edit `pr_reviewer` configurations, you can run: