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

Added PRHelpMessage to command execution in pr_agent.py

Browse Source
This commit is contained in:
mrT23
2024-02-18 13:06:57 +02:00
parent e9382b18b6
commit ed5856493c
1 changed files with 25 additions and 29 deletions
Download Patch File Download Diff File Expand all files Collapse all files

54
pr_agent/tools/pr_help_message.py
View File

@ -8,38 +8,34 @@ class PRHelpMessage:
The PRConfig class is responsible for listing all configuration options available for the user.
"""
def __init__(self, pr_url: str, args=None, ai_handler=None):
"""
Initialize the PRConfig object with the necessary attributes and objects to comment on a pull request.
Args:
pr_url (str): The URL of the pull request to be reviewed.
args (list, optional): List of arguments passed to the PRReviewer class. Defaults to None.
"""
self.git_provider = get_git_provider()(pr_url)
async def run(self):
get_logger().info('Getting PR Help Message...')
pr_comment="## PR Agent Intro\n\n"
pr_comment +="🤖 Welcome to the PR Agent, an AI-powered tool for automated pull request analysis, feedback, suggestions and more."""
pr_comment +="\n\nHere are the tools you can use to interact with the PR Agent:\n"
base_path ="https://github.com/Codium-ai/pr-agent/tree/main/docs"
pr_comment +=f"""
\n\n
- [DESCRIBE]({base_path}/DESCRIBE.md)
- [REVIEW]({base_path}/REVIEW.md)
- [IMPROVE](./IMPROVE.md)
- [ASK]({base_path}/ASK.md)
- [SIMILAR_ISSUE]({base_path}/SIMILAR_ISSUE.md)
- [UPDATE CHANGELOG]({base_path}/UPDATE_CHANGELOG.md)
- [ADD DOCUMENTATION]({base_path}/ADD_DOCUMENTATION.md)
- [GENERATE CUSTOM LABELS]({base_path}/GENERATE_CUSTOM_LABELS.md)
- [Analyze]({base_path}/Analyze.md)
- [Test]({base_path}/TEST.md)
- [CI Feedback]({base_path}/CI_FEEDBACK.md)
"""
pr_comment +=f"""\n\nNote that each command be [applied automatically](https://github.com/Codium-ai/pr-agent/blob/main/Usage.md#github-app-automatic-tools-for-pr-actions) when a new PR is opened, or invoked manually by [commenting on a PR](https://github.com/Codium-ai/pr-agent/blob/main/Usage.md#online-usage)."""
if get_settings().config.publish_output:
self.git_provider.publish_comment(pr_comment)
try:
get_logger().info('Getting PR Help Message...')
pr_comment="## PR Agent Intro\n\n"
pr_comment +="🤖 Welcome to the PR Agent, an AI-powered tool for automated pull request analysis, feedback, suggestions and more."""
pr_comment +="\n\nHere are the tools you can use to interact with the PR Agent:\n"
base_path ="https://github.com/Codium-ai/pr-agent/tree/main/docs"
pr_comment +=f"""
\n\n
- [DESCRIBE]({base_path}/DESCRIBE.md)
- [REVIEW]({base_path}/REVIEW.md)
- [IMPROVE]({base_path}/IMPROVE.md)
- [ASK]({base_path}/ASK.md)
- [SIMILAR_ISSUE]({base_path}/SIMILAR_ISSUE.md)
- [UPDATE CHANGELOG]({base_path}/UPDATE_CHANGELOG.md)
- [ADD DOCUMENTATION]({base_path}/ADD_DOCUMENTATION.md)
- [GENERATE CUSTOM LABELS]({base_path}/GENERATE_CUSTOM_LABELS.md)
- [Analyze]({base_path}/Analyze.md)
- [Test]({base_path}/TEST.md)
- [CI Feedback]({base_path}/CI_FEEDBACK.md)
"""
pr_comment +=f"""\n\nNote that each command be [applied automatically](https://github.com/Codium-ai/pr-agent/blob/main/Usage.md#github-app-automatic-tools-for-pr-actions) when a new PR is opened, or invoked manually by [commenting on a PR](https://github.com/Codium-ai/pr-agent/blob/main/Usage.md#online-usage)."""
if get_settings().config.publish_output:
self.git_provider.publish_comment(pr_comment)
except Exception as e:
get_logger().error(f"Error while running PRHelpMessage: {e}")
return ""
def _prepare_pr_configs(self) -> str: