Skip to content

Commit 5db48f1

Browse files
committed
docs(ruleset): document required_reviewers rule parameter
Add documentation for the new required_reviewers nested block in both organization_ruleset and repository_ruleset resources. Documents the reviewer, file_patterns, and minimum_approvals attributes with their types and requirements.
1 parent 6fbff95 commit 5db48f1

2 files changed

Lines changed: 32 additions & 0 deletions

File tree

website/docs/r/organization_ruleset.html.markdown

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -211,6 +211,22 @@ The `rules` block supports the following:
211211

212212
* `required_review_thread_resolution` - (Optional) (Boolean) All conversations on code must be resolved before a pull request can be merged. Defaults to `false`.
213213

214+
* `required_reviewers` - (Optional) (Block List) Require specific reviewers to approve pull requests. Note: This feature is in beta. (see [below for nested schema](#rules.pull_request.required_reviewers))
215+
216+
#### rules.pull_request.required_reviewers ####
217+
218+
* `reviewer` - (Required) (Block List, Max: 1) The reviewer that must review matching files. (see [below for nested schema](#rules.pull_request.required_reviewers.reviewer))
219+
220+
* `file_patterns` - (Required) (List of String) File patterns (fnmatch syntax) that this reviewer must approve.
221+
222+
* `minimum_approvals` - (Required) (Number) Minimum number of approvals required from this reviewer. Set to 0 to make approval optional.
223+
224+
#### rules.pull_request.required_reviewers.reviewer ####
225+
226+
* `id` - (Required) (Number) The ID of the reviewer (Team ID).
227+
228+
* `type` - (Required) (String) The type of reviewer. Currently only `Team` is supported.
229+
214230
#### rules.required_status_checks ####
215231

216232
* `required_check` - (Required) (Block Set, Min: 1) Status checks that are required. Several can be defined. (see [below for nested schema](#rules.required_status_checks.required_check))

website/docs/r/repository_ruleset.html.markdown

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -217,6 +217,22 @@ The `rules` block supports the following:
217217

218218
* `required_review_thread_resolution` - (Optional) (Boolean) All conversations on code must be resolved before a pull request can be merged. Defaults to `false`.
219219

220+
* `required_reviewers` - (Optional) (Block List) Require specific reviewers to approve pull requests. Note: This feature is in beta. (see [below for nested schema](#rules.pull_request.required_reviewers))
221+
222+
#### rules.pull_request.required_reviewers ####
223+
224+
* `reviewer` - (Required) (Block List, Max: 1) The reviewer that must review matching files. (see [below for nested schema](#rules.pull_request.required_reviewers.reviewer))
225+
226+
* `file_patterns` - (Required) (List of String) File patterns (fnmatch syntax) that this reviewer must approve.
227+
228+
* `minimum_approvals` - (Required) (Number) Minimum number of approvals required from this reviewer. Set to 0 to make approval optional.
229+
230+
#### rules.pull_request.required_reviewers.reviewer ####
231+
232+
* `id` - (Required) (Number) The ID of the reviewer (Team ID).
233+
234+
* `type` - (Required) (String) The type of reviewer. Currently only `Team` is supported.
235+
220236
#### rules.required_deployments ####
221237

222238
* `required_deployment_environments` - (Required) (List of String) The environments that must be successfully deployed to before branches can be merged.

0 commit comments

Comments
 (0)