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

feat: Update user description extraction and placement in PR description

Browse Source
This commit is contained in:
mrT23
2024-01-04 18:01:55 +02:00
parent 3e29848cd0
commit 7762bf59bf
3 changed files with 19 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
pr_agent/git_providers/git_provider.py
View File

@ -75,20 +75,33 @@ class GitProvider(ABC):
def get_user_description(self) -> str: def get_user_description(self) -> str:
description = (self.get_pr_description_full() or "").strip() description = (self.get_pr_description_full() or "").strip()
description_lowercase = description.lower() description_lowercase = description.lower()
# if the existing description wasn't generated by the pr-agent, just return it as-is # if the existing description wasn't generated by the pr-agent, just return it as-is
if not self._is_generated_by_pr_agent(description_lowercase): if not self._is_generated_by_pr_agent(description_lowercase):
return description return description
# if the existing description was generated by the pr-agent, but it doesn't contain the user description,
# if the existing description was generated by the pr-agent, but it doesn't contain a user description,
# return nothing (empty string) because it means there is no user description # return nothing (empty string) because it means there is no user description
user_description_header = "## user description" user_description_header = "## user description"
if user_description_header not in description_lowercase: if user_description_header not in description_lowercase:
return "" return ""
# otherwise, extract the original user description from the existing pr-agent description and return it # otherwise, extract the original user description from the existing pr-agent description and return it
user_description_start_position = description_lowercase.find(user_description_header) + len(user_description_header) # user_description_start_position = description_lowercase.find(user_description_header) + len(user_description_header)
return description[user_description_start_position:].split("\n", 1)[-1].strip() # return description[user_description_start_position:].split("\n", 1)[-1].strip()
# the 'user description' is in the beginning. extract and return it
original_user_description = description.split("___")[0].strip()
if original_user_description.lower().startswith(user_description_header):
original_user_description = original_user_description[len(user_description_header):].strip()
return original_user_description
def _is_generated_by_pr_agent(self, description_lowercase: str) -> bool: def _is_generated_by_pr_agent(self, description_lowercase: str) -> bool:
possible_headers = ("## pr type", "## pr description", "## pr labels", "## type", "## description", "## labels", "### 🤖 generated by pr agent") possible_headers = (
"## user description", "## pr type", "## pr description", "## pr labels", "## type", "## description",
"## labels", "### 🤖 generated by pr agent")
return any(description_lowercase.startswith(header) for header in possible_headers) return any(description_lowercase.startswith(header) for header in possible_headers)
@abstractmethod @abstractmethod

2
pr_agent/settings/configuration.toml
View File

@ -46,7 +46,7 @@ enable_help_text=true # Determines whether to include help text in the PR review
[pr_description] # /describe # [pr_description] # /describe #
publish_labels=true publish_labels=true
publish_description_as_comment=false publish_description_as_comment=false
add_original_user_description=false add_original_user_description=true
keep_original_user_title=false keep_original_user_title=false
use_bullet_points=true use_bullet_points=true
extra_instructions = "" extra_instructions = ""

2
pr_agent/tools/pr_description.py
View File

@ -186,7 +186,7 @@ class PRDescription:
self.data = load_yaml(self.prediction.strip()) self.data = load_yaml(self.prediction.strip())
if get_settings().pr_description.add_original_user_description and self.user_description: if get_settings().pr_description.add_original_user_description and self.user_description:
self.data["User Description"] = self.user_description + "\n\n___\n\n" self.data["User Description"] = self.user_description
# re-order keys # re-order keys
if 'User Description' in self.data: if 'User Description' in self.data: