Adding new argument to the branch_default resource to allow renaming the default branch on the repository without the need of first calling the github_branch resource (#1523)

Co-authored-by: Keegan Campbell <me@kfcampbell.com>

Author: rhughes1

github/resource_github_branch_default.go

@@ -27,6 +27,11 @@ func resourceGithubBranchDefault() *schema.Resource {
 				Required: true,
 				ForceNew: true,
 			},
+			"rename": {
+				Type:     schema.TypeBool,
+				Optional: true,
+				Default:  false,
+			},
 		},
 	}
 }
@@ -37,15 +42,26 @@ func resourceGithubBranchDefaultCreate(d *schema.ResourceData, meta interface{})
 	owner := meta.(*Owner).name
 	repoName := d.Get("repository").(string)
 	defaultBranch := d.Get("branch").(string)
-
-	repository := &github.Repository{
-		DefaultBranch: &defaultBranch,
-	}
+	rename := d.Get("rename").(bool)
 
 	ctx := context.Background()
 
-	if _, _, err := client.Repositories.Edit(ctx, owner, repoName, repository); err != nil {
-		return err
+	if rename {
+		repository, _, err := client.Repositories.Get(ctx, owner, repoName)
+		if err != nil {
+			return err
+		}
+		if _, _, err := client.Repositories.RenameBranch(ctx, owner, repoName, *repository.DefaultBranch, defaultBranch); err != nil {
+			return err
+		}
+	} else {
+		repository := &github.Repository{
+			DefaultBranch: &defaultBranch,
+		}
+
+		if _, _, err := client.Repositories.Edit(ctx, owner, repoName, repository); err != nil {
+			return err
+		}
 	}
 
 	d.SetId(repoName)
@@ -98,15 +114,26 @@ func resourceGithubBranchDefaultUpdate(d *schema.ResourceData, meta interface{})
 	owner := meta.(*Owner).name
 	repoName := d.Id()
 	defaultBranch := d.Get("branch").(string)
-
-	repository := &github.Repository{
-		DefaultBranch: &defaultBranch,
-	}
+	rename := d.Get("rename").(bool)
 
 	ctx := context.Background()
 
-	if _, _, err := client.Repositories.Edit(ctx, owner, repoName, repository); err != nil {
-		return err
+	if rename {
+		repository, _, err := client.Repositories.Get(ctx, owner, repoName)
+		if err != nil {
+			return err
+		}
+		if _, _, err := client.Repositories.RenameBranch(ctx, owner, repoName, *repository.DefaultBranch, defaultBranch); err != nil {
+			return err
+		}
+	} else {
+		repository := &github.Repository{
+			DefaultBranch: &defaultBranch,
+		}
+
+		if _, _, err := client.Repositories.Edit(ctx, owner, repoName, repository); err != nil {
+			return err
+		}
 	}
 
 	return resourceGithubBranchDefaultRead(d, meta)

github/resource_github_branch_default_test.go

@@ -118,4 +118,54 @@ func TestAccGithubBranchDefault(t *testing.T) {
 		})
 
 	})
+
+	t.Run("replaces the default_branch of a repository without creating a branch resource prior to", func(t *testing.T) {
+
+		config := fmt.Sprintf(`
+			resource "github_repository" "test" {
+				name      = "tf-acc-test-%s"
+				auto_init = true
+			}
+			
+			resource "github_branch_default" "test"{
+				repository = github_repository.test.name
+				branch     = "development"
+				rename     = true
+			}
+
+		`, randomID)
+
+		check := resource.ComposeTestCheckFunc(
+			resource.TestCheckResourceAttr(
+				"github_branch_default.test", "branch",
+				"development",
+			),
+		)
+
+		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,
+					},
+				},
+			})
+		}
+
+		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)
+		})
+
+	})
 }

website/docs/r/branch_default.html.markdown

@@ -15,6 +15,8 @@ Note that use of this resource is incompatible with the `default_branch` option
 
 ## Example Usage
 
+Basic usage:
+
 ```hcl
 resource "github_repository" "example" {
   name        = "example"
@@ -33,12 +35,29 @@ resource "github_branch_default" "default"{
 }
 ```
 
+Renaming to a branch that doesn't exist:
+
+```hcl
+resource "github_repository" "example" {
+  name        = "example"
+  description = "My awesome codebase"
+  auto_init   = true
+}
+
+resource "github_branch_default" "default"{
+  repository = github_repository.example.name
+  branch     = "development"
+  rename     = true
+}
+```
+
 ## Argument Reference
 
 The following arguments are supported:
 
 * `repository` - (Required) The GitHub repository
 * `branch` - (Required) The branch (e.g. `main`)
+* `rename` - (Optional) Indicate if it should rename the branch rather than use an existing branch. Defaults to `false`. 
 
 ## Import