fix(resource_github_branch): creating branch and repo with gitignore doesn't 422 [1284] (#1679)

Co-authored-by: Nick Floyd <[email protected]>
Co-authored-by: Keegan Campbell <[email protected]>

Author: 3 people

github/resource_github_branch.go

@@ -94,7 +94,9 @@ func resourceGithubBranchCreate(d *schema.ResourceData, meta interface{}) error
 		Ref:    &branchRefName,
 		Object: &github.GitObject{SHA: &sourceBranchSHA},
 	})
-	if err != nil {
+	// If the branch already exists, rather than erroring out just continue on to importing the branch
+	//   This avoids the case where a repo with gitignore_template and branch are being created at the same time crashing terraform
+	if err != nil && !strings.HasSuffix(err.Error(), "422 Reference already exists []") {
 		return fmt.Errorf("error creating GitHub branch reference %s/%s (%s): %s",
 			orgName, repoName, branchRefName, err)
 	}

github/resource_github_branch_test.go

@@ -76,6 +76,70 @@ func TestAccGithubBranch(t *testing.T) {
 
 	})
 
+	t.Run("creates a branch named main directly and a repository with a gitignore_template", func(t *testing.T) {
+
+		config := fmt.Sprintf(`
+			resource "github_repository" "test" {
+			  name = "tf-acc-test-%[1]s"
+			  auto_init = true
+			  gitignore_template = "Python"
+			}
+
+			resource "github_branch" "test" {
+			  repository = github_repository.test.id
+			  branch     = "main"
+			}
+		`, randomID)
+
+		check := resource.ComposeTestCheckFunc(
+			resource.TestMatchResourceAttr(
+				"github_branch.test", "id",
+				regexp.MustCompile(fmt.Sprintf("tf-acc-test-%s:test", randomID)),
+			),
+		)
+
+		testCase := func(t *testing.T, mode string) {
+			resource.Test(t, resource.TestCase{
+				PreCheck:  func() { skipUnlessMode(t, mode) },
+				Providers: testAccProviders,
+				Steps: []resource.TestStep{
+					{
+						Config: config,
+						Check:  check,
+					},
+					{
+						ResourceName:            "github_branch.test",
+						ImportState:             true,
+						ImportStateId:           fmt.Sprintf("tf-acc-test-%s:test", randomID),
+						ImportStateVerify:       true,
+						ImportStateVerifyIgnore: []string{"source_sha"},
+					},
+					{
+						ResourceName:  "github_branch.test",
+						ImportState:   true,
+						ImportStateId: fmt.Sprintf("tf-acc-test-%s:nonsense", randomID),
+						ExpectError: regexp.MustCompile(
+							"Repository tf-acc-test-[a-z0-9]* does not have a branch named nonsense.",
+						),
+					},
+				},
+			})
+		}
+
+		t.Run("with an anonymous account", func(t *testing.T) {
+			t.Skip("anonymous account not supported for this operation")
+		})
+
+		t.Run("with an individual account", func(t *testing.T) {
+			testCase(t, individual)
+		})
+
+		t.Run("with an organization account", func(t *testing.T) {
+			testCase(t, organization)
+		})
+
+	})
+
 	t.Run("creates a branch from a source branch", func(t *testing.T) {
 
 		config := fmt.Sprintf(`