Skip to content

Commit 3866012

Browse files
mikutaskfcampbell
andauthored
docs: describe how actor_id / integration_id can be found (#2474)
* update r/repository_ruleset * Update website/docs/r/repository_ruleset.html.markdown * Update website/docs/r/repository_ruleset.html.markdown --------- Co-authored-by: Keegan Campbell <[email protected]>
1 parent 9b69b20 commit 3866012

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

website/docs/r/repository_ruleset.html.markdown

+4-4
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ resource "github_repository_ruleset" "example" {
4949
required_deployment_environments = ["test"]
5050
}
5151
52-
52+
5353
}
5454
}
5555
```
@@ -104,7 +104,7 @@ The `rules` block supports the following:
104104
* `required_code_scanning` - (Optional) (Block List, Max: 1) Define which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated. Multiple code scanning tools can be specified. (see [below for nested schema](#rules.required_code_scanning))
105105

106106
* `update` - (Optional) (Boolean) Only allow users with bypass permission to update matching refs.
107-
107+
108108
* `update_allows_fetch_and_merge` - (Optional) (Boolean) Branch can pull changes from its upstream repository. This is only applicable to forked repositories. Requires `update` to be set to `true`. Note: behaviour is affected by a known bug on the GitHub side which may cause issues when using this parameter.
109109

110110
#### rules.branch_name_pattern ####
@@ -179,7 +179,7 @@ The `rules` block supports the following:
179179

180180
* `context` - (Required) (String) The status check context name that must be present on the commit.
181181

182-
* `integration_id` - (Optional) (Number) The optional integration ID that this status check must originate from.
182+
* `integration_id` - (Optional) (Number) The optional integration ID that this status check must originate from. It's a GitHub App ID, which can be obtained by following instructions from the [Get an App API docs](https://docs.github.com/en/rest/apps/apps?apiVersion=2022-11-28#get-an-app).
183183

184184
#### rules.tag_name_pattern ####
185185

@@ -205,7 +205,7 @@ The `rules` block supports the following:
205205

206206
#### bypass_actors ####
207207

208-
* `actor_id` - (Required) (Number) The ID of the actor that can bypass a ruleset.
208+
* `actor_id` - (Required) (Number) The ID of the actor that can bypass a ruleset. If `actor_type` is `Integration`, `actor_id` is a GitHub App ID. App ID can be obtained by following instructions from the [Get an App API docs](https://docs.github.com/en/rest/apps/apps?apiVersion=2022-11-28#get-an-app)
209209

210210
* `actor_type` (String) The type of actor that can bypass a ruleset. Can be one of: `RepositoryRole`, `Team`, `Integration`, `OrganizationAdmin`.
211211

0 commit comments

Comments
 (0)