Skip to content

Commit bf5da9a

Browse files
committed
docs: add configuration options for ticket analysis review in compliance tool
1 parent ede3f82 commit bf5da9a

2 files changed

Lines changed: 36 additions & 5 deletions

File tree

docs/docs/core-abilities/fetching_ticket_context.md

Lines changed: 32 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -54,27 +54,54 @@ A `PR Code Verified` label indicates the PR code meets ticket requirements, but
5454

5555
#### Configuration options
5656

57-
-
57+
-
5858

59-
By default, the tool will automatically validate if the PR complies with the referenced ticket.
59+
By default, the `review` tool will automatically validate if the PR complies with the referenced ticket.
6060
If you want to disable this feedback, add the following line to your configuration file:
61-
61+
6262
```toml
6363
[pr_reviewer]
6464
require_ticket_analysis_review=false
6565
```
6666

67-
-
67+
-
6868

6969
If you set:
7070
```toml
7171
[pr_reviewer]
7272
check_pr_additional_content=true
7373
```
7474
(default: `false`)
75-
75+
7676
the `review` tool will also validate that the PR code doesn't contain any additional content that is not related to the ticket. If it does, the PR will be labeled at best as `PR Code Verified`, and the `review` tool will provide a comment with the additional unrelated content found in the PR code.
7777

78+
### Compliance tool
79+
80+
The `compliance` tool also uses ticket context to validate that PR changes fulfill the requirements specified in linked tickets.
81+
82+
#### Configuration options
83+
84+
-
85+
86+
By default, the `compliance` tool will automatically validate if the PR complies with the referenced ticket.
87+
If you want to disable ticket compliance checking in the compliance tool, add the following line to your configuration file:
88+
89+
```toml
90+
[pr_compliance]
91+
require_ticket_analysis_review=false
92+
```
93+
94+
-
95+
96+
If you set:
97+
```toml
98+
[pr_compliance]
99+
check_pr_additional_content=true
100+
```
101+
(default: `false`)
102+
103+
the `compliance` tool will also validate that the PR code doesn't contain any additional content that is not related to the ticket.
104+
78105
## GitHub/Gitlab Issues Integration
79106

80107
Qodo Merge will automatically recognize GitHub/Gitlab issues mentioned in the PR description and fetch the issue content.

docs/docs/tools/compliance.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -329,6 +329,10 @@ enable_global_pr_compliance = true
329329
???+ example "Ticket compliance options"
330330

331331
<table>
332+
<tr>
333+
<td><b>require_ticket_analysis_review</b></td>
334+
<td>If set to true, the tool will fetch and analyze ticket context for compliance validation. Default is true.</td>
335+
</tr>
332336
<tr>
333337
<td><b>enable_ticket_labels</b></td>
334338
<td>If set to true, the tool will add ticket compliance labels to the PR. Default is false.</td>

0 commit comments

Comments
 (0)