Skip to content

Commit 3d6b2f4

Browse files
committed
docs: clarify actor types and IDs in bypass_mode section of enterprise ruleset documentation
1 parent 194e9b2 commit 3d6b2f4

File tree

1 file changed

+4
-6
lines changed

1 file changed

+4
-6
lines changed

website/docs/r/enterprise_ruleset.html.markdown

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -529,13 +529,11 @@ The `rules` block supports the following:
529529

530530
- `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

532-
~>Note: at the time of writing this, the following actor types correspond to the following actor IDs:
532+
~>Note: For `RepositoryRole` actor type, the following are the base repository roles and their associated IDs:
533533

534-
- `OrganizationAdmin` -> `1`
535-
- `RepositoryRole` (This is the actor type, the following are the base repository roles and their associated IDs.)
536-
- `maintain` -> `2`
537-
- `write` -> `4`
538-
- `admin` -> `5`
534+
- `maintain` -> `2`
535+
- `write` -> `4`
536+
- `admin` -> `5`
539537

540538
### conditions
541539

0 commit comments

Comments
 (0)