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

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

Browse Source
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
Download Patch File Download Diff File Expand all files Collapse all files

11
docs/docs/tools/describe.md
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. - `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 ...". - `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" !!! 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: - 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_commands = ["/describe --pr_description.add_original_user_description=true ..."]
"--pr_description.keep_original_user_title=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: <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. - 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: - For maximal automation, you can change the default mode to:
``` ```
pr_commands = ["/describe --pr_description.add_original_user_description=false" 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: - 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", ...] pr_commands = ["/describe --pr_description.use_description_markers=true", ...]

11
docs/docs/usage-guide/automations_and_usage.md
View File

@ -62,20 +62,19 @@ The configuration parameter `pr_commands` defines the list of tools that will be
``` ```
[github_app] [github_app]
pr_commands = [ 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", "/review --pr_reviewer.num_code_suggestions=0",
"/improve", "/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. 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**. 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: For example, if your local `.pr_agent.toml` file contains:
``` ```
[pr_description] [pr_description]
add_original_user_description = false 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. 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] [github_app]
handle_push_trigger = true handle_push_trigger = true
push_commands = [ 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", "/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] [gitlab]
pr_commands = [ 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", "/review --pr_reviewer.num_code_suggestions=0",
"/improve", "/improve",
] ]
@ -202,7 +201,7 @@ To control which commands will run automatically when a new PR is opened, you ca
``` ```
[azure_devops_server] [azure_devops_server]
pr_commands = [ 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", "/review --pr_reviewer.num_code_suggestions=0",
"/improve", "/improve",
] ]

2
docs/docs/usage-guide/configuration_options.md
View File

@ -23,7 +23,7 @@ An example content:
``` ```
[pr_description] [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. PR-Agent will know to remove the triple-quotes when reading the configuration content.

5
pr_agent/servers/help.py
View File

@ -68,10 +68,9 @@ some_config2=...
output += """\ output += """\
- When you first install the app, the [default mode](https://pr-agent-docs.codium.ai/usage-guide/automations_and_usage/#github-app-automatic-tools-when-a-new-pr-is-opened) for the describe tool is: - When you first install the app, the [default mode](https://pr-agent-docs.codium.ai/usage-guide/automations_and_usage/#github-app-automatic-tools-when-a-new-pr-is-opened) for the describe tool is:
``` ```
pr_commands = ["/describe --pr_description.add_original_user_description=true" pr_commands = ["/describe --pr_description.add_original_user_description=true ..."]
"--pr_description.keep_original_user_title=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.
- Markers are an alternative way to control the generated description, to give maximal control to the user. If you set: - Markers are an alternative way to control the generated description, to give maximal control to the user. If you set:
``` ```

8
pr_agent/settings/configuration.toml
View File

@ -53,7 +53,7 @@ maximal_review_effort=5
[pr_description] # /describe # [pr_description] # /describe #
publish_labels=true publish_labels=true
add_original_user_description=true add_original_user_description=true
keep_original_user_title=true generate_ai_title=false
use_bullet_points=true use_bullet_points=true
extra_instructions = "" extra_instructions = ""
enable_pr_type=true enable_pr_type=true
@ -148,7 +148,7 @@ override_deployment_type = true
# settings for "pull_request" event # settings for "pull_request" event
handle_pr_actions = ['opened', 'reopened', 'ready_for_review'] handle_pr_actions = ['opened', 'reopened', 'ready_for_review']
pr_commands = [ 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", "/review --pr_reviewer.num_code_suggestions=0",
"/improve", "/improve",
] ]
@ -160,7 +160,7 @@ push_trigger_wait_for_initial_review = true
push_trigger_pending_tasks_backlog = true push_trigger_pending_tasks_backlog = true
push_trigger_pending_tasks_ttl = 300 push_trigger_pending_tasks_ttl = 300
push_commands = [ 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", "/review --pr_reviewer.num_code_suggestions=0",
] ]
ignore_pr_title = [] ignore_pr_title = []
@ -169,7 +169,7 @@ ignore_bot_pr = true
[gitlab] [gitlab]
url = "https://gitlab.com" # URL to the gitlab service url = "https://gitlab.com" # URL to the gitlab service
pr_commands = [ 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", "/review --pr_reviewer.num_code_suggestions=0",
"/improve", "/improve",
] ]

2
pr_agent/tools/pr_description.py
View File

@ -301,7 +301,7 @@ class PRDescription:
# Remove the 'PR Title' key from the dictionary # Remove the 'PR Title' key from the dictionary
ai_title = self.data.pop('title', self.vars["title"]) ai_title = self.data.pop('title', self.vars["title"])
if get_settings().pr_description.keep_original_user_title: if (not get_settings().pr_description.generate_ai_title):
# Assign the original PR title to the 'title' variable # Assign the original PR title to the 'title' variable
title = self.vars["title"] title = self.vars["title"]
else: else: