Remove repository target after thorough testing that it doesn't do anything

Signed-off-by: Timo Sand <[email protected]>

Author: deiga

github/repository_rules_validation_utils.go

@@ -155,17 +155,3 @@ func validateConditionsFieldForPushTarget(ctx context.Context, conditions map[st
 	tflog.Debug(ctx, "Conditions validation passed for push target")
 	return nil
 }
-
-func validateConditionsFieldForRepositoryTarget(ctx context.Context, conditions map[string]any) error {
-	tflog.Debug(ctx, "Validating conditions field for repository target", map[string]any{"target": "repository", "conditions": conditions})
-
-	if conditions["ref_name"] != nil && len(conditions["ref_name"].([]any)) > 0 {
-		tflog.Debug(ctx, "Invalid ref_name for repository target", map[string]any{"ref_name": conditions["ref_name"]})
-		return fmt.Errorf("ref_name must not be set for repository target")
-	}
-	if conditions["repository_name"] == nil || len(conditions["repository_name"].([]any)) == 0 || conditions["repository_id"] == nil || len(conditions["repository_id"].([]any)) == 0 {
-		return fmt.Errorf("one of repository_name or repository_id must be set for repository target")
-	}
-	tflog.Debug(ctx, "Conditions validation passed for repository target")
-	return nil
-}

github/resource_github_organization_ruleset.go

@@ -41,10 +41,11 @@ func resourceGithubOrganizationRuleset() *schema.Resource {
 				Description:  "The name of the ruleset.",
 			},
 			"target": {
-				Type:         schema.TypeString,
-				Required:     true,
-				ValidateFunc: validation.StringInSlice([]string{"branch", "tag", "push", "repository"}, false),
-				Description:  "The target of the ruleset. Possible values are `branch`, `tag`, `push` and `repository`.",
+				Type:     schema.TypeString,
+				Required: true,
+				// The API accepts an `repository` target, but any rule created with that doesn't show up in the UI, nor does it have any rules.
+				ValidateFunc: validation.StringInSlice([]string{"branch", "tag", "push"}, false),
+				Description:  "The target of the ruleset. Possible values are `branch`, `tag` and `push`.",
 			},
 			"enforcement": {
 				Type:         schema.TypeString,
@@ -94,7 +95,7 @@ func resourceGithubOrganizationRuleset() *schema.Resource {
 				Type:        schema.TypeList,
 				Optional:    true,
 				MaxItems:    1,
-				Description: "Parameters for an organization ruleset condition. `ref_name` is required for `branch` and `tag` targets, but must not be set for `push` or `repository` targets. One of `repository_name` or `repository_id` is always required.",
+				Description: "Parameters for an organization ruleset condition. `ref_name` is required for `branch` and `tag` targets, but must not be set for `push` targets. One of `repository_name` or `repository_id` is always required.",
 				Elem: &schema.Resource{
 					Schema: map[string]*schema.Schema{
 						"ref_name": {
@@ -861,8 +862,6 @@ func validateConditionsFieldBasedOnTarget(ctx context.Context, d *schema.Resourc
 		return validateConditionsFieldForBranchAndTagTargets(ctx, target, conditions)
 	case "push":
 		return validateConditionsFieldForPushTarget(ctx, conditions)
-	case "repository":
-		return validateConditionsFieldForRepositoryTarget(ctx, conditions)
 	}
 	return nil
 }

github/resource_github_organization_ruleset_test.go

@@ -36,10 +36,10 @@ name: Echo Workflow
 on: [pull_request]
 
 jobs:
-  echo:
-    runs-on: linux
-    steps:
-      - run: echo \"Hello, world!\"
+	echo:
+		runs-on: linux
+		steps:
+			- run: echo \"Hello, world!\"
 EOT
 	commit_message      = "Managed by Terraform"
 	commit_author       = "Terraform User"
@@ -673,9 +673,9 @@ resource "github_organization_ruleset" "test" {
 		})
 	})
 
-	t.Run("creates_push_ruleset_with_only_repository_name", func(t *testing.T) {
+	t.Run("creates_push_ruleset", func(t *testing.T) {
 		randomID := acctest.RandStringFromCharSet(5, acctest.CharSetAlphaNum)
-		resourceName := "test-push-repo-name-only"
+		resourceName := "test-push-ruleset"
 		config := fmt.Sprintf(`
 			resource "github_organization_ruleset" "%s" {
 				name        = "test-push-%s"
@@ -816,44 +816,6 @@ resource "github_organization_ruleset" "test" {
 			})
 		})
 	})
-
-	t.Run("validates_repository_target_rejects_ref_name", func(t *testing.T) {
-		randomID := acctest.RandStringFromCharSet(5, acctest.CharSetAlphaNum)
-		resourceName := "test-repository-reject-ref-name"
-		config := fmt.Sprintf(`
-			resource "github_organization_ruleset" "%s" {
-				name        = "test-repo-with-ref-%s"
-				target      = "repository"
-				enforcement = "active"
-
-				conditions {
-					ref_name {
-						include = ["~ALL"]
-						exclude = []
-					}
-					repository_name {
-						include = ["~ALL"]
-						exclude = []
-					}
-				}
-
-				rules {
-					creation = true
-				}
-			}
-		`, resourceName, randomID)
-
-		resource.Test(t, resource.TestCase{
-			PreCheck:          func() { skipUnlessHasPaidOrgs(t) },
-			ProviderFactories: providerFactories,
-			Steps: []resource.TestStep{
-				{
-					Config:      config,
-					ExpectError: regexp.MustCompile("ref_name must not be set for repository target"),
-				},
-			},
-		})
-	})
 }
 
 func TestOrganizationPushRulesetSupport(t *testing.T) {