Replace keep_original_user_title with generate_ai_title for PR description customization and update documentation accordingly

This commit is contained in:
mrT23
2024-04-17 16:29:12 +03:00
parent b076c33351
commit 2f4e40860d
6 changed files with 18 additions and 21 deletions

View File

@ -56,7 +56,7 @@ publish_labels = ...
- `add_original_user_description`: if set to true, the tool will add the original user description to the generated description. Default is true.
- `keep_original_user_title`: if set to true, the tool will keep the original PR title, and won't change it. Default is true.
- `generate_ai_title`: if set to true, the tool will also generate an AI title for the PR. Default is false.
- `extra_instructions`: Optional extra instructions to the tool. For example: "focus on the changes in the file X. Ignore change in ...".
@ -168,18 +168,17 @@ The description should be comprehensive and detailed, indicating when to add the
!!! tip "Automation"
- When you first install PR-Agent app, the [default mode](../usage-guide/automations_and_usage.md#github-app) for the describe tool is:
```
pr_commands = ["/describe --pr_description.add_original_user_description=true"
"--pr_description.keep_original_user_title=true", ...]
pr_commands = ["/describe --pr_description.add_original_user_description=true ..."]
```
meaning the `describe` tool will run automatically on every PR, will keep the original title, and will add the original user description above the generated description.
meaning the `describe` tool will run automatically on every PR, and will add the original user description above the generated description.
<br> This default settings aim to strike a good balance between automation and control:
- If you want more automation, just give the PR a title, and the tool will auto-write a full description; If you want more control, you can add a detailed description, and the tool will add the complementary description below it.
- For maximal automation, you can change the default mode to:
```
pr_commands = ["/describe --pr_description.add_original_user_description=false"
"--pr_description.keep_original_user_title=true", ...]
" --pr_description.generate_ai_tile=true", ...]
```
so the title will be auto-generated as well.
so the title of the PR will be auto-generated as well.
- Markers are an alternative way to control the generated description, to give maximal control to the user. If you set:
```
pr_commands = ["/describe --pr_description.use_description_markers=true", ...]

View File

@ -62,20 +62,19 @@ The configuration parameter `pr_commands` defines the list of tools that will be
```
[github_app]
pr_commands = [
"/describe --pr_description.add_original_user_description=true --pr_description.keep_original_user_title=true --pr_description.final_update_message=false",
"/describe --pr_description.add_original_user_description=true --pr_description.final_update_message=false",
"/review --pr_reviewer.num_code_suggestions=0",
"/improve",
]
```
This means that when a new PR is opened/reopened or marked as ready for review, PR-Agent will run the `describe`, `review` and `improve` tools.
For the `describe` tool, for example, the `add_original_user_description` and `keep_original_user_title` parameters will be set to true.
For the `describe` tool, for example, the `add_original_user_description` parameter will be set to true.
You can override the default tool parameters by using one the three options for a [configuration file](https://codium-ai.github.io/Docs-PR-Agent/usage-guide/#configuration-options): **wiki**, **local**, or **global**.
For example, if your local `.pr_agent.toml` file contains:
```
[pr_description]
add_original_user_description = false
keep_original_user_title = false
```
When a new PR is opened, PR-Agent will run the `describe` tool with the above parameters.
@ -102,7 +101,7 @@ The configuration parameter `push_commands` defines the list of tools that will
[github_app]
handle_push_trigger = true
push_commands = [
"/describe --pr_description.add_original_user_description=true --pr_description.keep_original_user_title=true",
"/describe --pr_description.add_original_user_description=true",
"/review --pr_reviewer.num_code_suggestions=0 --pr_reviewer.final_update_message=false",
]
```
@ -142,7 +141,7 @@ After setting up a GitLab webhook, to control which commands will run automatica
```
[gitlab]
pr_commands = [
"/describe --pr_description.add_original_user_description=true --pr_description.keep_original_user_title=true",
"/describe --pr_description.add_original_user_description=true",
"/review --pr_reviewer.num_code_suggestions=0",
"/improve",
]
@ -202,7 +201,7 @@ To control which commands will run automatically when a new PR is opened, you ca
```
[azure_devops_server]
pr_commands = [
"/describe --pr_description.add_original_user_description=true --pr_description.keep_original_user_title=true",
"/describe --pr_description.add_original_user_description=true",
"/review --pr_reviewer.num_code_suggestions=0",
"/improve",
]

View File

@ -23,7 +23,7 @@ An example content:
```
[pr_description]
keep_original_user_title=false
generate_ai_title=true
```
PR-Agent will know to remove the triple-quotes when reading the configuration content.