Skip to content

[BUG] Change allowed_merge_methods to Optional #3083

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
stevehipwell merged 3 commits into from
Jan 16, 2026
Merged

[BUG] Change allowed_merge_methods to Optional #3083

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f8d6f69
Fix missing docs
deiga Jan 16, 2026
3326ec6
Set `allowed_merge_methods` to `Optional`
deiga Jan 16, 2026
3ffbe0d
Enable running `repository_ruleset` tests on `enterprise` testmode
deiga Jan 16, 2026
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
2 changes: 1 addition & 1 deletion github/resource_github_organization_ruleset.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -200,7 +200,7 @@ func resourceGithubOrganizationRuleset() *schema.Resource {
Schema: map[string]*schema.Schema{
"allowed_merge_methods": {
Type: schema.TypeList,
Required: true,
Optional: true,
MinItems: 1,
Description: "Array of allowed merge methods. Allowed values include `merge`, `squash`, and `rebase`. At least one option must be enabled.",
Elem: &schema.Schema{
Expand Down
1 change: 0 additions & 1 deletion github/resource_github_organization_ruleset_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,6 @@ resource "github_organization_ruleset" "test" {
required_signatures = false

pull_request {
allowed_merge_methods = ["merge", "rebase", "squash"]
required_approving_review_count = 2
required_review_thread_resolution = true
require_code_owner_review = true
Expand Down
2 changes: 1 addition & 1 deletion github/resource_github_repository_ruleset.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -191,7 +191,7 @@ func resourceGithubRepositoryRuleset() *schema.Resource {
Schema: map[string]*schema.Schema{
"allowed_merge_methods": {
Type: schema.TypeList,
Required: true,
Optional: true,
MinItems: 1,
Description: "Array of allowed merge methods. Allowed values include `merge`, `squash`, and `rebase`. At least one option must be enabled.",
Elem: &schema.Schema{
Expand Down
71 changes: 44 additions & 27 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 @@ -13,6 +13,10 @@ import (
)

func TestAccGithubRepositoryRuleset(t *testing.T) {
baseVisibility := "public"
if testAccConf.authMode == enterprise {
baseVisibility = "private" // Enable tests to run on GHEC EMU
}
t.Run("create_branch_ruleset", func(t *testing.T) {
randomID := acctest.RandStringFromCharSet(5, acctest.CharSetAlphaNum)
repoName := fmt.Sprintf("%srepo-ruleset-%s", testResourcePrefix, randomID)
Expand All @@ -23,6 +27,7 @@ resource "github_repository" "test" {
auto_init = true
default_branch = "main"
vulnerability_alerts = true
visibility = "%s"
}

resource "github_repository_environment" "example" {
Expand Down Expand Up @@ -112,7 +117,7 @@ resource "github_repository_ruleset" "test" {
}
}
}
`, repoName)
`, repoName, baseVisibility)

resource.Test(t, resource.TestCase{
PreCheck: func() { skipUnauthenticated(t) },
Expand Down Expand Up @@ -150,6 +155,7 @@ resource "github_repository_ruleset" "test" {
name = "%s"
auto_init = false
vulnerability_alerts = true
visibility = "%s"
}

resource "github_repository_environment" "example" {
Expand Down Expand Up @@ -179,7 +185,7 @@ resource "github_repository_ruleset" "test" {
}
}
}
`, repoName)
`, repoName, baseVisibility)

resource.Test(t, resource.TestCase{
PreCheck: func() { skipUnlessMode(t, enterprise) },
Expand Down Expand Up @@ -231,7 +237,7 @@ resource "github_repository_ruleset" "test" {
}

max_file_size {
max_file_size = 1048576
max_file_size = 99
}

file_extension_restriction {
Expand All @@ -252,14 +258,14 @@ resource "github_repository_ruleset" "test" {
resource.TestCheckResourceAttr("github_repository_ruleset.test", "name", "test-push"),
resource.TestCheckResourceAttr("github_repository_ruleset.test", "target", "push"),
resource.TestCheckResourceAttr("github_repository_ruleset.test", "enforcement", "active"),
resource.TestCheckResourceAttr("github_organization_ruleset.test", "bypass_actors.#", "2"),
resource.TestCheckResourceAttr("github_organization_ruleset.test", "bypass_actors.0.actor_type", "DeployKey"),
resource.TestCheckResourceAttr("github_organization_ruleset.test", "bypass_actors.0.bypass_mode", "always"),
resource.TestCheckResourceAttr("github_organization_ruleset.test", "bypass_actors.1.actor_id", "5"),
resource.TestCheckResourceAttr("github_organization_ruleset.test", "bypass_actors.1.actor_type", "RepositoryRole"),
resource.TestCheckResourceAttr("github_organization_ruleset.test", "bypass_actors.1.bypass_mode", "always"),
resource.TestCheckResourceAttr("github_repository_ruleset.test", "bypass_actors.#", "2"),
resource.TestCheckResourceAttr("github_repository_ruleset.test", "bypass_actors.0.actor_type", "DeployKey"),
resource.TestCheckResourceAttr("github_repository_ruleset.test", "bypass_actors.0.bypass_mode", "always"),
resource.TestCheckResourceAttr("github_repository_ruleset.test", "bypass_actors.1.actor_id", "5"),
resource.TestCheckResourceAttr("github_repository_ruleset.test", "bypass_actors.1.actor_type", "RepositoryRole"),
resource.TestCheckResourceAttr("github_repository_ruleset.test", "bypass_actors.1.bypass_mode", "always"),
resource.TestCheckResourceAttr("github_repository_ruleset.test", "rules.0.file_path_restriction.0.restricted_file_paths.0", "test.txt"),
resource.TestCheckResourceAttr("github_repository_ruleset.test", "rules.0.max_file_size.0.max_file_size", "1048576"),
resource.TestCheckResourceAttr("github_repository_ruleset.test", "rules.0.max_file_size.0.max_file_size", "99"),
resource.TestCheckResourceAttr("github_repository_ruleset.test", "rules.0.file_extension_restriction.0.restricted_file_extensions.0", "*.zip"),
),
},
Expand All @@ -275,13 +281,14 @@ resource "github_repository_ruleset" "test" {

config := `
resource "github_repository" "test" {
name = "%[1]s"
description = "Terraform acceptance tests %[2]s"
name = "%s"
description = "Terraform acceptance tests %s"
vulnerability_alerts = true
visibility = "%s"
}

resource "github_repository_ruleset" "test" {
name = "%[3]s"
name = "%s"
repository = github_repository.test.id
target = "branch"
enforcement = "active"
Expand All @@ -297,13 +304,13 @@ resource "github_repository_ruleset" "test" {
ProviderFactories: providerFactories,
Steps: []resource.TestStep{
{
Config: fmt.Sprintf(config, repoName, randomID, name),
Config: fmt.Sprintf(config, repoName, randomID, baseVisibility, name),
Check: resource.ComposeTestCheckFunc(
resource.TestCheckResourceAttr("github_repository_ruleset.test", "name", name),
),
},
{
Config: fmt.Sprintf(config, repoName, randomID, nameUpdated),
Config: fmt.Sprintf(config, repoName, randomID, baseVisibility, nameUpdated),
Check: resource.ComposeTestCheckFunc(
resource.TestCheckResourceAttr("github_repository_ruleset.test", "name", nameUpdated),
),
Expand All @@ -321,6 +328,7 @@ resource "github_repository" "test" {
name = "%s"
description = "Terraform acceptance tests %[1]s"
auto_init = true
visibility = "%s"
}

resource "github_repository_ruleset" "test" {
Expand Down Expand Up @@ -351,13 +359,14 @@ resource "github_repository_ruleset" "test" {
creation = true
}
}
`, repoName)
`, repoName, baseVisibility)

configUpdated := fmt.Sprintf(`
resource "github_repository" "test" {
name = "%s"
description = "Terraform acceptance tests %[1]s"
auto_init = true
visibility = "%s"
}

resource "github_repository_ruleset" "test" {
Expand All @@ -377,7 +386,7 @@ resource "github_repository_ruleset" "test" {
creation = true
}
}
`, repoName)
`, repoName, baseVisibility)

resource.Test(t, resource.TestCase{
PreCheck: func() { skipUnauthenticated(t) },
Expand Down Expand Up @@ -406,11 +415,12 @@ resource "github_repository_ruleset" "test" {
bypassMode := "always"
bypassModeUpdated := "exempt"

config := fmt.Sprintf(`
config := `
resource "github_repository" "test" {
name = "%s"
description = "Terraform acceptance tests %s"
auto_init = true
visibility = "%s"
}

resource "github_repository_ruleset" "test" {
Expand All @@ -436,20 +446,20 @@ resource "github_repository_ruleset" "test" {
creation = true
}
}
`, repoName, randomID, bypassMode)
`

resource.Test(t, resource.TestCase{
PreCheck: func() { skipUnauthenticated(t) },
Providers: testAccProviders,
Steps: []resource.TestStep{
{
Config: fmt.Sprintf(config, randomID, bypassMode),
Config: fmt.Sprintf(config, repoName, randomID, baseVisibility, bypassMode),
Check: resource.ComposeTestCheckFunc(
resource.TestCheckResourceAttr("github_repository_ruleset.test", "bypass_actors.0.bypass_mode", bypassMode),
),
},
{
Config: fmt.Sprintf(config, randomID, bypassModeUpdated),
Config: fmt.Sprintf(config, repoName, randomID, baseVisibility, bypassModeUpdated),
Check: resource.ComposeTestCheckFunc(
resource.TestCheckResourceAttr("github_repository_ruleset.test", "bypass_actors.0.bypass_mode", bypassModeUpdated),
),
Expand All @@ -468,7 +478,8 @@ resource "github_repository_ruleset" "test" {
description = "Terraform acceptance tests %s"
auto_init = true
default_branch = "main"
vulnerability_alerts = true
vulnerability_alerts = true
visibility = "%s"
}

resource "github_repository_environment" "example" {
Expand All @@ -493,7 +504,7 @@ resource "github_repository_ruleset" "test" {
creation = true
}
}
`, repoName, randomID)
`, repoName, randomID, baseVisibility)

resource.Test(t, resource.TestCase{
PreCheck: func() { skipUnauthenticated(t) },
Expand All @@ -515,6 +526,10 @@ resource "github_repository_ruleset" "test" {
}

func TestAccGithubRepositoryRulesetArchived(t *testing.T) {
baseVisibility := "public"
if testAccConf.authMode == enterprise {
baseVisibility = "private" // Enable tests to run on GHEC EMU
}
t.Run("skips update and delete on archived repository", func(t *testing.T) {
randomID := acctest.RandStringFromCharSet(5, acctest.CharSetAlphaNum)
repoName := fmt.Sprintf("%srepo-ruleset-arch-%s", testResourcePrefix, randomID)
Expand All @@ -523,6 +538,7 @@ func TestAccGithubRepositoryRulesetArchived(t *testing.T) {
name = "%s"
auto_init = true
archived = false
visibility = "%s"
}

resource "github_repository_ruleset" "test" {
Expand All @@ -532,10 +548,10 @@ func TestAccGithubRepositoryRulesetArchived(t *testing.T) {
enforcement = "active"
rules { creation = true }
}
`, repoName)
`, repoName, baseVisibility)

resource.Test(t, resource.TestCase{
PreCheck: func() { skipUnlessMode(t, individual) },
PreCheck: func() { skipUnauthenticated(t) },
Providers: testAccProviders,
Steps: []resource.TestStep{
{Config: config},
Expand All @@ -553,6 +569,7 @@ func TestAccGithubRepositoryRulesetArchived(t *testing.T) {
name = "%s"
auto_init = true
archived = true
visibility = "%s"
}
resource "github_repository_ruleset" "test" {
name = "test"
Expand All @@ -561,10 +578,10 @@ func TestAccGithubRepositoryRulesetArchived(t *testing.T) {
enforcement = "active"
rules { creation = true }
}
`, repoName)
`, repoName, baseVisibility)

resource.Test(t, resource.TestCase{
PreCheck: func() { skipUnlessMode(t, individual) },
PreCheck: func() { skipUnauthenticated(t) },
Providers: testAccProviders,
Steps: []resource.TestStep{
{Config: config, ExpectError: regexp.MustCompile("cannot create ruleset on archived repository")},
Expand Down
Loading