Skip to content

Commit bbf6c24

Browse files
mikutaskfcampbell
authored andcommitted
docs: describe how actor_id / integration_id can be found (integrations#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 8747576 commit bbf6c24

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

website/docs/r/repository_ruleset.html.markdown

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -190,7 +190,7 @@ The `rules` block supports the following:
190190

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

193-
* `integration_id` - (Optional) (Number) The optional integration ID that this status check must originate from.
193+
* `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).
194194

195195
#### rules.tag_name_pattern ####
196196

@@ -216,7 +216,7 @@ The `rules` block supports the following:
216216

217217
#### bypass_actors ####
218218

219-
* `actor_id` - (Required) (Number) The ID of the actor that can bypass a ruleset.
219+
* `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)
220220

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

0 commit comments

Comments
 (0)