xiaxinhang/pr-agent
1
0
Fork 0
mirror of https://github.com/qodo-ai/pr-agent.git synced 2025-07-10 15:50:37 +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

5
pr_agent/servers/help.py
View File

@ -68,10 +68,9 @@ some_config2=...
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:
```
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.
- 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 #
publish_labels=true
add_original_user_description=true
keep_original_user_title=true
generate_ai_title=false
use_bullet_points=true
extra_instructions = ""
enable_pr_type=true
@ -148,7 +148,7 @@ override_deployment_type = true
# settings for "pull_request" event
handle_pr_actions = ['opened', 'reopened', 'ready_for_review']
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",
]
@ -160,7 +160,7 @@ push_trigger_wait_for_initial_review = true
push_trigger_pending_tasks_backlog = true
push_trigger_pending_tasks_ttl = 300
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",
]
ignore_pr_title = []
@ -169,7 +169,7 @@ ignore_bot_pr = true
[gitlab]
url = "https://gitlab.com" # URL to the gitlab service
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",
]

2
pr_agent/tools/pr_description.py
View File

@ -301,7 +301,7 @@ class PRDescription:
# Remove the 'PR Title' key from the dictionary
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
title = self.vars["title"]
else: