Skip to content

Commit 4673b38

Browse files
authored
Document new issues_limit option for code-review (#835)
* Document new issues_limit option for code-review * Format unlimited as code for issues_limit
1 parent 6c64948 commit 4673b38

3 files changed

Lines changed: 4 additions & 1 deletion

File tree

docs/automation-actions.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -289,6 +289,7 @@ This action, once triggered, reviews the code in the PR, and generates a comment
289289
| -----------|------|-----|------------------------------------------------ |
290290
| `approve_on_LGTM` | Optional | Bool | Approve this PR if no issues were found. Default is `false` |
291291
| `guidelines` | Optional | String | Provides custom instructions to the AI model to tailor the code review. Can be inline text or loaded from a file using the `readFile()` function. |
292+
| `issues_limit` | Optional | Integer \| `unlimited` | Limits the number of issues included in the generated code review comment. Set to a positive integer (e.g., `10`) or `unlimited` to include all issues. Default is `3`. |
292293

293294
</div>
294295

docs/automations/integrations/LinearBAI/code-review/README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,8 @@ Use LinearB's AI with the [`code-review`](/automation-actions/#code-review) acti
2222
Automation Actions:
2323

2424
* Perform an AI-driven code review and append the review comments to the PR.
25-
* Use `guidelines` to add your prompts to the team or org review
25+
* Use `guidelines` to add your prompts to the team or org review.
26+
* Use `issues_limit` to control how many issues are included in the review comment (number or `unlimited`).
2627

2728
!!! example "Configuration Example"
2829
```yaml+jinja

docs/downloads/automation-library/integrations/LinearBAI/code-review.cm

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ automations:
1212
- action: code-review@v1
1313
args:
1414
approve_on_LGTM: {{ approve_pr_on_lgtm }} # optional arg, you can remove it
15+
issues_limit: 10 # optional arg; set to a positive integer or "unlimited"
1516
guidelines: {{ guidelines }}
1617

1718
# Define variables

0 commit comments

Comments
 (0)