usage guide

This commit is contained in:
mrT23
2024-01-07 09:56:09 +02:00
parent 8ec790d4f7
commit 578d15c6fc
8 changed files with 231 additions and 40 deletions

View File

@ -17,7 +17,7 @@ from pr_agent.config_loader import get_settings
from pr_agent.git_providers import get_git_provider
from pr_agent.git_providers.git_provider import IncrementalPR, get_main_pr_language
from pr_agent.log import get_logger
from pr_agent.servers.help import actions_help_text, bot_help_text
from pr_agent.servers.help import HelpMessage
class PRReviewer:
@ -249,16 +249,11 @@ class PRReviewer:
data.move_to_end('Incremental PR Review', last=False)
markdown_text = convert_to_markdown(data, self.git_provider.is_supported("gfm_markdown"))
user = self.git_provider.get_user_id()
# Add help text if gfm_markdown is supported
if self.git_provider.is_supported("gfm_markdown") and get_settings().pr_reviewer.enable_help_text:
markdown_text += "\n\n<details> <summary><strong>✨ Usage tips:</strong></summary><hr> \n\n"
bot_user = "[bot]" if get_settings().github_app.override_deployment_type else get_settings().github_app.bot_user
if user and bot_user not in user and not get_settings().get("CONFIG.CLI_MODE", False):
markdown_text += bot_help_text(user)
else:
markdown_text += actions_help_text
markdown_text += "<hr>\n\n<details> <summary><strong>✨ Usage guide:</strong></summary><hr> \n\n"
markdown_text += HelpMessage.get_review_usage_guide()
markdown_text += "\n</details>\n"
# Add custom labels from the review prediction (effort, security)