You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/docs/usage-guide/automations_and_usage.md
+14-10Lines changed: 14 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -101,37 +101,41 @@ When this parameter is set to `true`, Qodo Merge will not run any automatic tool
101
101
102
102
#### GitHub app automatic tools when a new PR is opened
103
103
104
-
The [github_app](https://github.com/Codium-ai/pr-agent/blob/main/pr_agent/settings/configuration.toml#L108) section defines GitHub app specific configurations.
104
+
The [github_app](https://github.com/Codium-ai/pr-agent/blob/main/pr_agent/settings/configuration.toml#L220) section defines GitHub app specific configurations.
105
105
106
-
The configuration parameter `pr_commands` defines the list of tools that will be **run automatically** when a new PR is opened.
106
+
The configuration parameter `pr_commands` defines the list of tools that will be **run automatically** when a new PR is opened:
This means that when a new PR is opened/reopened or marked as ready for review, Qodo Merge will run the `describe`, `review` and `improve` tools.
117
-
For the `improve` tool, for example, the `suggestions_score_threshold` parameter will be set to 5 (suggestions below a score of 5 won't be presented)
118
117
119
118
You can override the default tool parameters by using one the three options for a [configuration file](https://qodo-merge-docs.qodo.ai/usage-guide/configuration_options/): **wiki**, **local**, or **global**.
120
-
For example, if your local `.pr_agent.toml` file contains:
119
+
For example, if your configuration file contains:
120
+
121
121
```toml
122
122
[pr_description]
123
123
generate_ai_title = true
124
124
```
125
-
Every time you run the `describe` tool, including automatic runs, the PR title will be generated by the AI.
126
125
127
-
To change which tools will run automatically when a new PR is opened, you can set the `pr_commands` parameter in the configuration file.
126
+
Every time you run the `describe` tool (including automatic runs) the PR title will be generated by the AI.
127
+
128
+
You can customize configurations specifically for automated runs by using the `--config_path=<value>` parameter.
129
+
For instance, to modify the `review` tool settings only for newly opened PRs, use:
128
130
```toml
129
131
[github_app]
130
-
pr_commands = ["describe", "review"]
132
+
pr_commands = [
133
+
"/describe",
134
+
"/review --pr_reviewer.extra_instructions='focus on the file: ...'",
135
+
"/improve",
136
+
]
131
137
```
132
138
133
-
In this case, only the `describe` and `review` tools will run automatically when a new PR is opened.
134
-
135
139
#### GitHub app automatic tools for push actions (commits to an open PR)
136
140
137
141
In addition to running automatic tools when a PR is opened, the GitHub app can also respond to new code that is pushed to an open PR.
0 commit comments