feat: Add support for repo private forking (#3056)

Signed-off-by: Steve Hipwell <steve.hipwell@gmail.com>

Author: stevehipwell

github/data_source_github_repository.go

@@ -9,12 +9,13 @@ import (
 	"strings"
 
 	"github.com/google/go-github/v81/github"
+	"github.com/hashicorp/terraform-plugin-sdk/v2/diag"
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
 )
 
 func dataSourceGithubRepository() *schema.Resource {
 	return &schema.Resource{
-		Read: dataSourceGithubRepositoryRead,
+		ReadContext: dataSourceGithubRepositoryRead,
 
 		Schema: map[string]*schema.Schema{
 			"full_name": {
@@ -95,6 +96,10 @@ func dataSourceGithubRepository() *schema.Resource {
 				Type:     schema.TypeBool,
 				Computed: true,
 			},
+			"allow_forking": {
+				Type:     schema.TypeBool,
+				Computed: true,
+			},
 			"squash_merge_commit_title": {
 				Type:     schema.TypeString,
 				Computed: true,
@@ -339,8 +344,7 @@ func dataSourceGithubRepository() *schema.Resource {
 	}
 }
 
-func dataSourceGithubRepositoryRead(d *schema.ResourceData, meta any) error {
-	ctx := context.Background()
+func dataSourceGithubRepositoryRead(ctx context.Context, d *schema.ResourceData, meta any) diag.Diagnostics {
 	client := meta.(*Owner).v3client
 	owner := meta.(*Owner).name
 	var repoName string
@@ -349,15 +353,15 @@ func dataSourceGithubRepositoryRead(d *schema.ResourceData, meta any) error {
 		var err error
 		owner, repoName, err = splitRepoFullName(fullName.(string))
 		if err != nil {
-			return err
+			return diag.FromErr(err)
 		}
 	}
 	if name, ok := d.GetOk("name"); ok {
 		repoName = name.(string)
 	}
 
 	if repoName == "" {
-		return fmt.Errorf("one of %q or %q has to be provided", "full_name", "name")
+		return diag.Errorf("one of %q or %q has to be provided", "full_name", "name")
 	}
 
 	repo, _, err := client.Repositories.Get(ctx, owner, repoName)
@@ -370,7 +374,7 @@ func dataSourceGithubRepositoryRead(d *schema.ResourceData, meta any) error {
 				return nil
 			}
 		}
-		return err
+		return diag.FromErr(err)
 	}
 
 	d.SetId(repoName)
@@ -389,6 +393,7 @@ func dataSourceGithubRepositoryRead(d *schema.ResourceData, meta any) error {
 	_ = d.Set("allow_squash_merge", repo.GetAllowSquashMerge())
 	_ = d.Set("allow_rebase_merge", repo.GetAllowRebaseMerge())
 	_ = d.Set("allow_auto_merge", repo.GetAllowAutoMerge())
+	_ = d.Set("allow_forking", repo.GetAllowForking())
 	_ = d.Set("squash_merge_commit_title", repo.GetSquashMergeCommitTitle())
 	_ = d.Set("squash_merge_commit_message", repo.GetSquashMergeCommitMessage())
 	_ = d.Set("merge_commit_title", repo.GetMergeCommitTitle())
@@ -412,25 +417,25 @@ func dataSourceGithubRepositoryRead(d *schema.ResourceData, meta any) error {
 	if repo.GetHasPages() {
 		pages, _, err := client.Repositories.GetPagesInfo(ctx, owner, repoName)
 		if err != nil {
-			return err
+			return diag.FromErr(err)
 		}
 		if err := d.Set("pages", flattenPages(pages)); err != nil {
-			return fmt.Errorf("error setting pages: %w", err)
+			return diag.Errorf("error setting pages: %v", err)
 		}
 	} else {
 		err = d.Set("pages", flattenPages(nil))
 		if err != nil {
-			return err
+			return diag.FromErr(err)
 		}
 	}
 
 	if repo.License != nil {
 		repository_license, _, err := client.Repositories.License(ctx, owner, repoName)
 		if err != nil {
-			return err
+			return diag.FromErr(err)
 		}
 		if err := d.Set("repository_license", flattenRepositoryLicense(repository_license)); err != nil {
-			return fmt.Errorf("error setting repository_license: %w", err)
+			return diag.Errorf("error setting repository_license: %v", err)
 		}
 	} else {
 		_ = d.Set("repository_license", flattenRepositoryLicense(nil))
@@ -444,18 +449,18 @@ func dataSourceGithubRepositoryRead(d *schema.ResourceData, meta any) error {
 			},
 		})
 		if err != nil {
-			return err
+			return diag.FromErr(err)
 		}
 	} else {
 		err = d.Set("template", []any{})
 		if err != nil {
-			return err
+			return diag.FromErr(err)
 		}
 	}
 
 	err = d.Set("topics", flattenStringList(repo.Topics))
 	if err != nil {
-		return err
+		return diag.FromErr(err)
 	}
 
 	return nil

github/data_source_github_repository_test.go

@@ -8,7 +8,7 @@ import (
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/resource"
 )
 
-func TestAccGithubRepositoryDataSource(t *testing.T) {
+func TestAccDataSourceGithubRepository(t *testing.T) {
 	t.Run("queries a public repository without error", func(t *testing.T) {
 		config := fmt.Sprintf(`
 			data "github_repository" "test" {

github/resource_github_repository.go

@@ -246,6 +246,12 @@ func resourceGithubRepository() *schema.Resource {
 				Default:     false,
 				Description: "Set to 'true' to allow auto-merging pull requests on the repository.",
 			},
+			"allow_forking": {
+				Type:        schema.TypeBool,
+				Optional:    true,
+				Default:     false,
+				Description: "Set to 'true' to allow private forking on the repository; this is only relevant if the repository is owned by an organization and is private or internal.",
+			},
 			"squash_merge_commit_title": {
 				Type:        schema.TypeString,
 				Optional:    true,
@@ -589,6 +595,7 @@ func resourceGithubRepositoryObject(d *schema.ResourceData) *github.Repository {
 		AllowSquashMerge:         github.Ptr(d.Get("allow_squash_merge").(bool)),
 		AllowRebaseMerge:         github.Ptr(d.Get("allow_rebase_merge").(bool)),
 		AllowAutoMerge:           github.Ptr(d.Get("allow_auto_merge").(bool)),
+		AllowForking:             github.Ptr(d.Get("allow_forking").(bool)),
 		DeleteBranchOnMerge:      github.Ptr(d.Get("delete_branch_on_merge").(bool)),
 		WebCommitSignoffRequired: github.Ptr(d.Get("web_commit_signoff_required").(bool)),
 		AutoInit:                 github.Ptr(d.Get("auto_init").(bool)),
@@ -841,6 +848,7 @@ func resourceGithubRepositoryRead(ctx context.Context, d *schema.ResourceData, m
 		_ = d.Set("allow_rebase_merge", repo.GetAllowRebaseMerge())
 		_ = d.Set("allow_squash_merge", repo.GetAllowSquashMerge())
 		_ = d.Set("allow_update_branch", repo.GetAllowUpdateBranch())
+		_ = d.Set("allow_forking", repo.GetAllowForking())
 		_ = d.Set("delete_branch_on_merge", repo.GetDeleteBranchOnMerge())
 		_ = d.Set("web_commit_signoff_required", repo.GetWebCommitSignoffRequired())
 		_ = d.Set("has_downloads", repo.GetHasDownloads())

github/resource_github_repository_test.go

@@ -15,7 +15,7 @@ import (
 	"github.com/stretchr/testify/assert"
 )
 
-func TestAccGithubRepositories(t *testing.T) {
+func TestAccGithubRepository(t *testing.T) {
 	t.Run("creates and updates repositories without error", func(t *testing.T) {
 		randomID := acctest.RandStringFromCharSet(5, acctest.CharSetAlphaNum)
 		config := fmt.Sprintf(`
@@ -558,6 +558,34 @@ func TestAccGithubRepositories(t *testing.T) {
 		})
 	})
 
+	t.Run("create_private_with_forking", func(t *testing.T) {
+		randomID := acctest.RandStringFromCharSet(5, acctest.CharSetAlphaNum)
+		repoName := fmt.Sprintf("tf-acc-test-%s", randomID)
+
+		config := fmt.Sprintf(`
+		resource "github_repository" "test" {
+			name       = "%s"
+			visibility = "private"
+
+			allow_forking = true
+		}
+		`, repoName)
+
+		resource.Test(t, resource.TestCase{
+			PreCheck:          func() { skipUnlessHasOrgs(t) },
+			ProviderFactories: providerFactories,
+			Steps: []resource.TestStep{
+				{
+					Config: config,
+					Check: resource.ComposeTestCheckFunc(
+						resource.TestCheckResourceAttr("github_repository.test", "visibility", "private"),
+						resource.TestCheckResourceAttr("github_repository.test", "allow_forking", "true"),
+					),
+				},
+			},
+		})
+	})
+
 	t.Run("configures vulnerability alerts for a private repository", func(t *testing.T) {
 		randomID := acctest.RandStringFromCharSet(5, acctest.CharSetAlphaNum)
 		repoName := fmt.Sprintf("tf-acc-test-prv-vuln-%s", randomID)

website/docs/d/repository.html.markdown

@@ -57,6 +57,8 @@ The following arguments are supported:
 
 * `allow_auto_merge` - Whether the repository allows auto-merging pull requests.
 
+* `allow_forking` - Whether the repository allows private forking; this is only relevant if the repository is owned by an organization and is private or internal.
+
 * `squash_merge_commit_title` - The default value for a squash merge commit title.
 
 * `squash_merge_commit_message` - The default value for a squash merge commit message.