Skip to content

Commit 194e9b2

Browse files
committed
docs: update bypass_actors section in enterprise ruleset documentation for clarity and accuracy
1 parent d330701 commit 194e9b2

1 file changed

Lines changed: 3 additions & 3 deletions

File tree

website/docs/r/enterprise_ruleset.html.markdown

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -523,11 +523,11 @@ The `rules` block supports the following:
523523

524524
### bypass_actors
525525

526-
- `actor_id` - (Optional) (Number) The ID of the actor that can bypass a ruleset. When `actor_type` is `OrganizationAdmin`, this should be set to `1`. Some resources such as DeployKey do not have an ID and this should be omitted.
526+
- `actor_id` - (Optional) (Number) The ID of the actor that can bypass a ruleset. Required for `Integration`, `RepositoryRole`, and `Team` actor types. If `actor_type` is `OrganizationAdmin` or `EnterpriseOwner`, `actor_id` is ignored. If `actor_type` is `DeployKey`, this should be null.
527527

528-
- `actor_type` - (Required) (String) The type of actor that can bypass a ruleset. Can be one of: `Integration`, `OrganizationAdmin`, `RepositoryRole`, `Team`, `DeployKey`.
528+
- `actor_type` - (Required) (String) The type of actor that can bypass a ruleset. Can be one of: `Integration`, `OrganizationAdmin`, `RepositoryRole`, `Team`, `DeployKey`, `EnterpriseOwner`.
529529

530-
- `bypass_mode` - (Required) (String) When the specified actor can bypass the ruleset. pull_request means that an actor can only bypass rules on pull requests. Can be one of: `always`, `pull_request`, `exempt`.
530+
- `bypass_mode` - (Required) (String) When the specified actor can bypass the ruleset. `pull_request` means that an actor can only bypass rules on pull requests. `pull_request` is not applicable for the `DeployKey` actor type. Also, `pull_request` is only applicable to branch rulesets. When `bypass_mode` is `exempt`, rules will not be run for that actor and a bypass audit entry will not be created. Can be one of: `always`, `pull_request`, `exempt`.
531531

532532
~>Note: at the time of writing this, the following actor types correspond to the following actor IDs:
533533

0 commit comments

Comments
 (0)