Refactor out branches attribute to new data source (integrations#1117)

* Refactor out branches attribute from resource_github_repository and data_source_github_repository

to data_source_github_repository_branches

* Add link to docs

* Update github/data_source_github_repository_branches.go

Co-authored-by: mareksapota-lyft <msapota@lyft.com>

* Add only_protected_branches in data source github_repository (integrations#1162)

This will allow to retrieve only the protected branches instead of the first 30.

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

* Remove mistakenly committed binary (integrations#1223)

* Revert PR integrations#1162 (integrations#1224)

* marek's suggestion + use v47

Co-authored-by: mareksapota-lyft <msapota@lyft.com>
Co-authored-by: Bertrand Paquet <bertrand.paquet@gmail.com>
Co-authored-by: Keegan Campbell <me@kfcampbell.com>

github/data_source_github_repository.go

@@ -108,22 +108,6 @@ func dataSourceGithubRepository() *schema.Resource {
 				Type:     schema.TypeBool,
 				Computed: true,
 			},
-			"branches": {
-				Type:     schema.TypeList,
-				Computed: true,
-				Elem: &schema.Resource{
-					Schema: map[string]*schema.Schema{
-						"name": {
-							Type:     schema.TypeString,
-							Computed: true,
-						},
-						"protected": {
-							Type:     schema.TypeBool,
-							Computed: true,
-						},
-					},
-				},
-			},
 			"pages": {
 				Type:     schema.TypeList,
 				Computed: true,

github/data_source_github_repository_branches.go

@@ -0,0 +1,70 @@
+package github
+
+import (
+	"context"
+	"fmt"
+
+	"github.com/google/go-github/v47/github"
+	"github.com/hashicorp/terraform-plugin-sdk/helper/schema"
+)
+
+func dataSourceGithubRepositoryBranches() *schema.Resource {
+	return &schema.Resource{
+		Read: dataSourceGithubRepositoryBranchesRead,
+		Schema: map[string]*schema.Schema{
+			"repository": {
+				Type:     schema.TypeString,
+				Required: true,
+			},
+			"branches": {
+				Type:     schema.TypeList,
+				Computed: true,
+				Elem: &schema.Resource{
+					Schema: map[string]*schema.Schema{
+						"name": {
+							Type:     schema.TypeString,
+							Computed: true,
+						},
+						"protected": {
+							Type:     schema.TypeBool,
+							Computed: true,
+						},
+					},
+				},
+			},
+		},
+	}
+}
+
+func flattenBranches(branches []*github.Branch) []interface{} {
+	if branches == nil {
+		return []interface{}{}
+	}
+
+	branchList := make([]interface{}, 0, len(branches))
+	for _, branch := range branches {
+		branchMap := make(map[string]interface{})
+		branchMap["name"] = branch.GetName()
+		branchMap["protected"] = branch.GetProtected()
+		branchList = append(branchList, branchMap)
+	}
+
+	return branchList
+}
+
+func dataSourceGithubRepositoryBranchesRead(d *schema.ResourceData, meta interface{}) error {
+	client := meta.(*Owner).v3client
+	orgName := meta.(*Owner).name
+	repoName := d.Get("repository").(string)
+
+	branches, _, err := client.Repositories.ListBranches(context.TODO(), orgName, repoName, nil)
+	if err != nil {
+		return err
+	}
+
+	d.SetId(fmt.Sprintf("%s/%s", orgName, repoName))
+	d.Set("repository", repoName)
+	d.Set("branches", flattenBranches(branches))
+
+	return nil
+}

github/data_source_github_repository_branches_test.go

@@ -0,0 +1,57 @@
+package github
+
+import (
+	"fmt"
+	"testing"
+
+	"github.com/hashicorp/terraform-plugin-sdk/helper/acctest"
+	"github.com/hashicorp/terraform-plugin-sdk/helper/resource"
+)
+
+func TestAccGithubRepositoryBranchesDataSource(t *testing.T) {
+	t.Run("manages branches of a new repository", func(t *testing.T) {
+		repoName := fmt.Sprintf("tf-acc-test-branches-%s", acctest.RandString(5))
+		config := fmt.Sprintf(`
+			resource "github_repository" "test" {
+				name      = "%s"
+				auto_init = true
+			}
+
+			data "github_repository_branches" "test" {
+				repository = github_repository.test.name
+			}
+		`, repoName)
+
+		const resourceName = "data.github_repository_branches.test"
+		check := resource.ComposeTestCheckFunc(
+			resource.TestCheckResourceAttr(resourceName, "branches.#", "1"),
+			resource.TestCheckResourceAttr(resourceName, "branches.0.name", "main"),
+			resource.TestCheckResourceAttr(resourceName, "branches.0.protected", "false"),
+		)
+
+		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)
+		})
+	})
+}

github/provider.go

@@ -148,6 +148,7 @@ func Provider() terraform.ResourceProvider {
 			"github_repositories":                  dataSourceGithubRepositories(),
 			"github_repositories_v2":               dataSourceGithubRepositoriesV2(),
 			"github_repository":                    dataSourceGithubRepository(),
+			"github_repository_branches":           dataSourceGithubRepositoryBranches(),
 			"github_repository_file":               dataSourceGithubRepositoryFile(),
 			"github_repository_milestone":          dataSourceGithubRepositoryMilestone(),
 			"github_repository_pull_request":       dataSourceGithubRepositoryPullRequest(),

github/resource_github_repository.go

@@ -147,22 +147,6 @@ func resourceGithubRepository() *schema.Resource {
 				Type:     schema.TypeBool,
 				Optional: true,
 			},
-			"branches": {
-				Type:     schema.TypeList,
-				Computed: true,
-				Elem: &schema.Resource{
-					Schema: map[string]*schema.Schema{
-						"name": {
-							Type:     schema.TypeString,
-							Computed: true,
-						},
-						"protected": {
-							Type:     schema.TypeBool,
-							Computed: true,
-						},
-					},
-				},
-			},
 			"pages": {
 				Type:     schema.TypeList,
 				MaxItems: 1,
@@ -482,12 +466,6 @@ func resourceGithubRepositoryRead(d *schema.ResourceData, meta interface{}) erro
 	d.Set("node_id", repo.GetNodeID())
 	d.Set("repo_id", repo.GetID())
 
-	branches, _, err := client.Repositories.ListBranches(ctx, owner, repoName, nil)
-	if err != nil {
-		return err
-	}
-	d.Set("branches", flattenBranches(branches))
-
 	if repo.GetHasPages() {
 		pages, _, err := client.Repositories.GetPagesInfo(ctx, owner, repoName)
 		if err != nil {
@@ -720,20 +698,3 @@ func flattenPages(pages *github.Pages) []interface{} {
 
 	return []interface{}{pagesMap}
 }
-
-func flattenBranches(branches []*github.Branch) []interface{} {
-	if branches == nil {
-		return []interface{}{}
-	}
-
-	branchList := make([]interface{}, 0, len(branches))
-
-	for _, branch := range branches {
-		branchMap := make(map[string]interface{})
-		branchMap["name"] = branch.Name
-		branchMap["protected"] = branch.Protected
-		branchList = append(branchList, branchMap)
-	}
-
-	return branchList
-}

website/docs/d/repository.html.markdown

@@ -84,7 +84,3 @@ The following arguments are supported:
 * `node_id` - GraphQL global node id for use with v4 API
 
 * `repo_id` - GitHub ID for the repository
-
-* `branches` - The list of this repository's branches. Each element of `branches` has the following attributes:
- * `name` - Name of the branch.
- * `protected` - Whether the branch is protected.

website/docs/d/repository_branches.html.markdown

@@ -0,0 +1,28 @@
+---
+layout: "github"
+page_title: "GitHub: repository_branches"
+description: |-
+  Get information on a Github repository's branches.
+---
+
+# github_repository_branches
+
+Use this data source to retrieve information about branches in a repository.
+
+## Example Usage
+
+```hcl
+data "github_repository_branches" "example" {
+    repository = "example-repository"
+}
+```
+
+## Argument Reference
+
+* `repository` - (Required) Name of the repository to retrieve the branches from.
+
+## Attributes Reference
+
+* `branches` - The list of this repository's branches. Each element of `branches` has the following attributes:
+    * `name` - Name of the branch.
+    * `protected` - Whether the branch is protected.

website/docs/r/repository.html.markdown

@@ -161,11 +161,6 @@ The following additional attributes are exported:
  * `html_url` - The absolute URL (including scheme) of the rendered GitHub Pages site e.g. `https://username.github.io`.
  * `status` - The GitHub Pages site's build status e.g. `building` or `built`.
 
-* `branches` - The list of this repository's branches. Each element of `branches` has the following attributes:
- * `name` - Name of the branch.
- * `protected` - Whether the branch is protected.
-
-
 ## Import
 
 Repositories can be imported using the `name`, e.g.

website/github.erb

@@ -52,6 +52,9 @@
             <li>
               <a href="/docs/providers/github/d/repository.html">github_repository</a>
             </li>
+            <li>
+              <a href="/docs/providers/github/d/repository_branches.html">github_repository_branches</a>
+            </li>
             <li>
               <a href="/docs/providers/github/d/repository_file.html">github_repository_file</a>
             </li>