Skip to content

feat: add DeployKey to bypass_actors in github_organization_ruleset and github_repository_ruleset #2255

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

feat: add DeployKey to bypass_actors in github_organization_ruleset and github_repository_ruleset #2255

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 8 additions & 6 deletions github/resource_github_organization_ruleset.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ import (
"context"
"fmt"
"log"
"math"
"net/http"
"strconv"

Expand Down Expand Up @@ -51,21 +52,22 @@ func resourceGithubOrganizationRuleset() *schema.Resource {
Elem: &schema.Resource{
Schema: map[string]*schema.Schema{
"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`.",
Type: schema.TypeInt,
Required: true,
ValidateFunc: validation.IntBetween(0, math.MaxInt64),
Description: "The ID of the actor that can bypass a ruleset. When `actor_type` is `OrganizationAdmin`, this should be set to `1`. If `actor_type` is `DeployKey`, this should be `0`.",
},
"actor_type": {
Type: schema.TypeString,
Required: true,
ValidateFunc: validation.StringInSlice([]string{"RepositoryRole", "Team", "Integration", "OrganizationAdmin"}, false),
Description: "The type of actor that can bypass a ruleset. Can be one of: `RepositoryRole`, `Team`, `Integration`, `OrganizationAdmin`.",
ValidateFunc: validation.StringInSlice([]string{"RepositoryRole", "Team", "Integration", "OrganizationAdmin", "DeployKey"}, false),
Description: "The type of actor that can bypass a ruleset. Can be one of: `RepositoryRole`, `Team`, `Integration`, `OrganizationAdmin`, `DeployKey`.",
},
"bypass_mode": {
Type: schema.TypeString,
Required: true,
ValidateFunc: validation.StringInSlice([]string{"always", "pull_request"}, false),
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`.",
Description: "When the specified actor can bypass the ruleset. `pull_request` means that an actor can only bypass rules on pull requests (not applicable for the `DeployKey` actor type). Can be one of: `always`, `pull_request`.",
},
},
},
Expand Down
12 changes: 12 additions & 0 deletions github/resource_github_organization_ruleset_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,12 @@ func TestGithubOrganizationRulesets(t *testing.T) {
}
}

bypass_actors {
actor_id = 0
actor_type = "DeployKey"
bypass_mode = "always"
}

rules {
creation = true

Expand Down Expand Up @@ -185,6 +191,12 @@ func TestGithubOrganizationRulesets(t *testing.T) {
}
}

bypass_actors {
actor_id = 0
actor_type = "DeployKey"
bypass_mode = "always"
}

rules {
creation = true

Expand Down
14 changes: 8 additions & 6 deletions github/resource_github_repository_ruleset.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ import (
"context"
"fmt"
"log"
"math"
"net/http"
"strconv"

Expand Down Expand Up @@ -56,21 +57,22 @@ func resourceGithubRepositoryRuleset() *schema.Resource {
Elem: &schema.Resource{
Schema: map[string]*schema.Schema{
"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`.",
Type: schema.TypeInt,
Required: true,
ValidateFunc: validation.IntBetween(0, math.MaxInt64),
Description: "The ID of the actor that can bypass a ruleset. When `actor_type` is `OrganizationAdmin`, this should be set to `1`. If `actor_type` is `DeployKey`, this should be `0`.",
},
"actor_type": {
Type: schema.TypeString,
Required: true,
ValidateFunc: validation.StringInSlice([]string{"RepositoryRole", "Team", "Integration", "OrganizationAdmin"}, false),
Description: "The type of actor that can bypass a ruleset. Can be one of: `RepositoryRole`, `Team`, `Integration`, `OrganizationAdmin`.",
ValidateFunc: validation.StringInSlice([]string{"RepositoryRole", "Team", "Integration", "OrganizationAdmin", "DeployKey"}, false),
Description: "The type of actor that can bypass a ruleset. Can be one of: `RepositoryRole`, `Team`, `Integration`, `OrganizationAdmin`, `DeployKey`.",
},
"bypass_mode": {
Type: schema.TypeString,
Required: true,
ValidateFunc: validation.StringInSlice([]string{"always", "pull_request"}, false),
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`.",
Description: "When the specified actor can bypass the ruleset. `pull_request` means that an actor can only bypass rules on pull requests (not applicable for the `DeployKey` actor type). Can be one of: `always`, `pull_request`.",
},
}},
},
Expand Down
24 changes: 24 additions & 0 deletions github/resource_github_repository_ruleset_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,12 @@ func TestGithubRepositoryRulesets(t *testing.T) {
}
}

bypass_actors {
actor_id = 0
actor_type = "DeployKey"
bypass_mode = "always"
}

rules {
creation = true

Expand Down Expand Up @@ -148,6 +154,12 @@ func TestGithubRepositoryRulesets(t *testing.T) {
}
}

bypass_actors {
actor_id = 0
actor_type = "DeployKey"
bypass_mode = "always"
}

rules {
branch_name_pattern {
name = "test"
Expand Down Expand Up @@ -207,6 +219,12 @@ func TestGithubRepositoryRulesets(t *testing.T) {
target = "branch"
enforcement = "active"

bypass_actors {
actor_id = 0
actor_type = "DeployKey"
bypass_mode = "always"
}

rules {
creation = true
}
Expand Down Expand Up @@ -290,6 +308,12 @@ func TestGithubRepositoryRulesets(t *testing.T) {
}
}

bypass_actors {
actor_id = 0
actor_type = "DeployKey"
bypass_mode = "always"
}

rules {
creation = true

Expand Down
3 changes: 3 additions & 0 deletions github/respository_rules_utils.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,9 @@ func expandBypassActors(input []interface{}) []*github.BypassActor {

if v, ok := inputMap["actor_type"].(string); ok {
actor.ActorType = &v
if actor.ActorType != nil && *actor.ActorType == "DeployKey" {
actor.ActorID = nil
}
}

if v, ok := inputMap["bypass_mode"].(string); ok {
Expand Down
4 changes: 2 additions & 2 deletions vendor/github.com/google/go-github/v57/github/repos_rules.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

5 changes: 3 additions & 2 deletions website/docs/r/organization_ruleset.html.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -185,12 +185,13 @@ The `rules` block supports the following:

* `actor_id` - (Required) (Number) The ID of the actor that can bypass a ruleset.

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

* `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`.
* `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 (not applicable for the `DeployKey` actor type). Can be one of: `always`, `pull_request`.

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

* `DeployKey` -> `0`
* `OrganizationAdmin` -> `1`
* `RepositoryRole` (This is the actor type, the following are the base repository roles and their associated IDs.)
* `maintain` -> `2`
Expand Down
5 changes: 3 additions & 2 deletions website/docs/r/repository_ruleset.html.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -197,11 +197,12 @@ The `rules` block supports the following:

* `actor_id` - (Required) (Number) The ID of the actor that can bypass a ruleset.

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

* `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`.
* `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 (not applicable for the `DeployKey` actor type). Can be one of: `always`, `pull_request`.

~> Note: at the time of writing this, the following actor types correspond to the following actor IDs:
* `DeployKey` -> `0`
* `OrganizationAdmin` -> `1`
* `RepositoryRole` (This is the actor type, the following are the base repository roles and their associated IDs.)
* `maintain` -> `2`
Expand Down