Skip to content

Commit d330701

Browse files
committed
chore: update descriptions for actor ID and bypass mode in enterprise ruleset schema
1 parent e3b52d1 commit d330701

1 file changed

Lines changed: 2 additions & 2 deletions

File tree

github/resource_github_enterprise_ruleset.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ func resourceGithubEnterpriseRuleset() *schema.Resource {
6666
Type: schema.TypeInt,
6767
Optional: true,
6868
Default: nil,
69-
Description: "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.",
69+
Description: "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.",
7070
},
7171
"actor_type": {
7272
Type: schema.TypeString,
@@ -78,7 +78,7 @@ func resourceGithubEnterpriseRuleset() *schema.Resource {
7878
Type: schema.TypeString,
7979
Required: true,
8080
ValidateDiagFunc: validation.ToDiagFunc(validation.StringInSlice([]string{"always", "pull_request", "exempt"}, false)),
81-
Description: "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`.",
81+
Description: "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.",
8282
},
8383
},
8484
},

0 commit comments

Comments
 (0)