Skip to content

Commit

Permalink
docs: describe how actor_id / integration_id can be found (#2474)
Browse files Browse the repository at this point in the history
* 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]>
  • Loading branch information
2 people authored and MXfive committed Nov 27, 2024
1 parent 8747576 commit bbf6c24
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions website/docs/r/repository_ruleset.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -190,7 +190,7 @@ The `rules` block supports the following:

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

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

#### rules.tag_name_pattern ####

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

#### bypass_actors ####

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

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

Expand Down

0 comments on commit bbf6c24

Please sign in to comment.