Update review.md

This commit is contained in:
ofir-frd
2025-03-14 12:02:26 +02:00
committed by GitHub
parent a211175fea
commit 677a54c5a0

View File

@ -51,7 +51,7 @@ extra_instructions = "..."
!!! example "General options"
<table>
<table>
<tr>
<td><b>persistent_comment</b></td>
<td>If set to true, the review comment will be persistent, meaning that every new review request will edit the previous one. Default is true.</td>
@ -68,11 +68,11 @@ extra_instructions = "..."
<td><b>enable_help_text</b></td>
<td>If set to true, the tool will display a help text in the comment. Default is true.</td>
</tr>
</table>
</table>
!!! example "Enable\\disable specific sub-sections"
<table>
<table>
<tr>
<td><b>require_score_review</b></td>
<td>If set to true, the tool will add a section that scores the PR. Default is false.</td>
@ -97,13 +97,13 @@ extra_instructions = "..."
<td><b>require_ticket_analysis_review</b></td>
<td>If set to true, and the PR contains a GitHub or Jira ticket link, the tool will add a section that checks if the PR in fact fulfilled the ticket requirements. Default is true.</td>
</tr>
</table>
</table>
!!! example "Adding PR labels"
You can enable\disable the `review` tool to add specific labels to the PR:
You can enable\disable the `review` tool to add specific labels to the PR:
<table>
<table>
<tr>
<td><b>enable_review_labels_security</b></td>
<td>If set to true, the tool will publish a 'possible security issue' label if it detects a security issue. Default is true.</td>
@ -112,7 +112,7 @@ You can enable\disable the `review` tool to add specific labels to the PR:
<td><b>enable_review_labels_effort</b></td>
<td>If set to true, the tool will publish a 'Review effort [1-5]: x' label. Default is true.</td>
</tr>
</table>
</table>
## Usage Tips