docs: actor_id for OrganizationAdmin changed to 0

Previously the actor_id used by the OrganizationAdmin actor_type was 1, this was changed to 0. A configuration using 1 does not result in an error, but any subsequent terraform plan detects the internal change to 0 and wants to update the actor_id.
integrations · Jan 14, 2025 · 9136d9f · 9136d9f
1 parent 4b77944
commit 9136d9f
Show file tree

Hide file tree

Showing 4 changed files with 4 additions and 4 deletions.
diff --git a/github/resource_github_organization_ruleset.go b/github/resource_github_organization_ruleset.go
@@ -53,7 +53,7 @@ func resourceGithubOrganizationRuleset() *schema.Resource {
 						"actor_id": {
 							Type:        schema.TypeInt,
 							Required:    true,
-							Description: "The ID of the actor that can bypass a ruleset. When `actor_type` is `OrganizationAdmin`, this should be set to `1`.",
+							Description: "The ID of the actor that can bypass a ruleset. When `actor_type` is `OrganizationAdmin`, this should be set to `0`.",
 						},
 						"actor_type": {
 							Type:         schema.TypeString,

diff --git a/github/resource_github_repository_ruleset.go b/github/resource_github_repository_ruleset.go
@@ -58,7 +58,7 @@ func resourceGithubRepositoryRuleset() *schema.Resource {
 						"actor_id": {
 							Type:        schema.TypeInt,
 							Required:    true,
-							Description: "The ID of the actor that can bypass a ruleset. When `actor_type` is `OrganizationAdmin`, this should be set to `1`.",
+							Description: "The ID of the actor that can bypass a ruleset. When `actor_type` is `OrganizationAdmin`, this should be set to `0`.",
 						},
 						"actor_type": {
 							Type:         schema.TypeString,

diff --git a/website/docs/r/organization_ruleset.html.markdown b/website/docs/r/organization_ruleset.html.markdown
@@ -205,7 +205,7 @@ The `rules` block supports the following:
 
 ~>Note: at the time of writing this, the following actor types correspond to the following actor IDs:
 
-* `OrganizationAdmin` -> `1`
+* `OrganizationAdmin` -> `0`
 * `RepositoryRole` (This is the actor type, the following are the base repository roles and their associated IDs.)
   * `maintain` -> `2`
   * `write` -> `4`

diff --git a/website/docs/r/repository_ruleset.html.markdown b/website/docs/r/repository_ruleset.html.markdown
@@ -214,7 +214,7 @@ The `rules` block supports the following:
 * `bypass_mode` - (Optional) (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`.
 
 ~> Note: at the time of writing this, the following actor types correspond to the following actor IDs:
-* `OrganizationAdmin` -> `1`
+* `OrganizationAdmin` -> `0`
 * `RepositoryRole` (This is the actor type, the following are the base repository roles and their associated IDs.)
   * `maintain` -> `2`
   * `write` -> `4`