Skip to content

Add feature can_admins_bypass for repo environments | fixed wait_timer issue for repo environments #2001

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

Merged
kfcampbell merged 6 commits into from
Nov 21, 2023
Merged

Add feature can_admins_bypass for repo environments | fixed wait_timer issue for repo environments #2001

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
6714acf
fix environment wait timer so GitHub stays in line with terraform
scott-doyland-burrows Nov 3, 2023
f5b2361
add abilty to use can_admins_bypass for environment protections
scott-doyland-burrows Nov 4, 2023
42ffbdf
update docs for repository environment can_admins_bypass
scott-doyland-burrows Nov 4, 2023
5f3aebe
refactored wait_timer code as the logic was broken in a previous comm…
scott-doyland-burrows Nov 4, 2023
03e0a1b
Merge branch 'main' into fix/env-wait-timer
kfcampbell Nov 10, 2023
b0e7ff6
Merge branch 'main' into fix/env-wait-timer
kfcampbell Nov 21, 2023
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
10 changes: 10 additions & 0 deletions github/resource_github_repository_environment.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,12 @@ func resourceGithubRepositoryEnvironment() *schema.Resource {
ForceNew: true,
Description: "The name of the environment.",
},
"can_admins_bypass": {
Type: schema.TypeBool,
Optional: true,
Default: true,
Description: "Can Admins bypass deployment protections",
},
"wait_timer": {
Type: schema.TypeInt,
Optional: true,
Expand Down Expand Up @@ -134,6 +140,8 @@ func resourceGithubRepositoryEnvironmentRead(d *schema.ResourceData, meta interf

d.Set("repository", repoName)
d.Set("environment", envName)
d.Set("wait_timer", nil)
d.Set("can_admins_bypass", env.CanAdminsBypass)

for _, pr := range env.ProtectionRules {
switch *pr.Type {
Expand Down Expand Up @@ -223,6 +231,8 @@ func createUpdateEnvironmentData(d *schema.ResourceData, meta interface{}) githu
data.WaitTimer = github.Int(v.(int))
}

data.CanAdminsBypass = github.Bool(d.Get("can_admins_bypass").(bool))

if v, ok := d.GetOk("reviewers"); ok {
envReviewers := make([]*github.EnvReviewers, 0)

Expand Down
13 changes: 7 additions & 6 deletions github/resource_github_repository_environment_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,12 +22,14 @@ func TestAccGithubRepositoryEnvironment(t *testing.T) {

resource "github_repository" "test" {
name = "tf-acc-test-%s"
visibility = "public"
}

resource "github_repository_environment" "test" {
repository = github_repository.test.name
environment = "environment/test"
wait_timer = 10000
can_admins_bypass = false
wait_timer = 10000
reviewers {
users = [data.github_user.current.id]
}
Expand All @@ -39,11 +41,10 @@ func TestAccGithubRepositoryEnvironment(t *testing.T) {

`, randomID)

check := resource.ComposeTestCheckFunc(
resource.TestCheckResourceAttr(
"github_repository_environment.test", "environment",
"environment/test",
),
check := resource.ComposeAggregateTestCheckFunc(
resource.TestCheckResourceAttr("github_repository_environment.test", "environment", "environment/test"),
resource.TestCheckResourceAttr("github_repository_environment.test", "can_admins_bypass", "false"),
resource.TestCheckResourceAttr("github_repository_environment.test", "wait_timer", "10000"),
)

testCase := func(t *testing.T, mode string) {
Expand Down
2 changes: 2 additions & 0 deletions website/docs/r/repository_environment.html.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,8 @@ The following arguments are supported:

* `wait_timer` - (Optional) Amount of time to delay a job after the job is initially triggered.

* `can_admins_bypass` - (Optional) Can repository admins bypass the environment protections. Defaults to `true`.

### Reviewers

The `reviewers` block supports the following:
Expand Down