Merge branch 'main' into fix/deleteRepositoryFIle

Author: nickfloyd

.github/workflows/release.yml

@@ -28,14 +28,14 @@ jobs:
           cache: true
 
       - name: Import GPG key
-        uses: crazy-max/ghaction-import-gpg@cb9bde2e2525e640591a934b1fd28eef1dcaf5e5 # v6.2.0
+        uses: crazy-max/ghaction-import-gpg@e89d40939c28e39f97cf32126055eeae86ba74ec # v6.3.0
         id: import_gpg
         with:
           gpg_private_key: ${{ secrets.GPG_PRIVATE_KEY }}
           passphrase: ${{ secrets.PASSPHRASE }}
 
       - name: Run GoReleaser
-        uses: goreleaser/goreleaser-action@9ed2f89a662bf1735a48bc8557fd212fa902bebf # v6.1.0
+        uses: goreleaser/goreleaser-action@e435ccd777264be153ace6237001ef4d979d3a7a # v6.4.0
         with:
           args: release --clean
           version: latest

.markdownlint.yaml

@@ -0,0 +1,4 @@
+MD013: false
+MD024:
+  siblings_only: true
+MD028: false

CONTRIBUTING.md

@@ -149,6 +149,9 @@ export GITHUB_OWNER=
 # enable testing of enterprise appliances
 export GITHUB_BASE_URL=
 
+# enable testing of GitHub Paid features, these normally also require an organization e.g. repository push rulesets
+export GITHUB_PAID_FEATURES=true
+
 # leverage helper accounts for tests requiring them
 # examples include:
 # - https://github.com/github-terraform-test-user

GNUmakefile

@@ -24,19 +24,19 @@ lint:
 	golangci-lint run ./...
 
 test:
-	go test ./...
+	CGO_ENABLED=0 go test ./...
 	# commenting this out for release tooling, please run testacc instead
 
 testacc: fmtcheck
-	TF_ACC=1 go test $(TEST) -v $(TESTARGS) -timeout 120m
+	TF_ACC=1 CGO_ENABLED=0 go test $(TEST) -v $(TESTARGS) -timeout 120m
 
 test-compile:
 	@if [ "$(TEST)" = "./..." ]; then \
 		echo "ERROR: Set TEST to a specific package. For example,"; \
 		echo "  make test-compile TEST=./$(PKG_NAME)"; \
 		exit 1; \
 	fi
-	go test -c $(TEST) $(TESTARGS)
+	CGO_ENABLED=0 go test -c $(TEST) $(TESTARGS)
 
 vet:
 	@echo "go vet ."

examples/secret-drifting/main.tf

@@ -0,0 +1,23 @@
+provider "github" {
+}
+
+terraform {
+  required_providers {
+    github = {
+      source  = "integrations/github"
+    }
+  }
+}
+
+resource "github_actions_organization_secret" "plaintext_secret" {
+  secret_name      = "test_plaintext_secret"
+  plaintext_value  = "123"
+  visibility       = "private"
+}
+
+resource "github_actions_organization_secret" "encrypted_secret" {
+  secret_name      = "test_encrypted_secret"
+  plaintext_value  = "123"
+  visibility       = "private"
+  destroy_on_drift = false
+}

github/data_source_github_issue_labels.go

@@ -2,9 +2,7 @@ package github
 
 import (
 	"context"
-	"fmt"
 
-	"github.com/google/go-github/v66/github"
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
 )
 
@@ -49,59 +47,19 @@ func dataSourceGithubIssueLabelsRead(d *schema.ResourceData, meta interface{}) e
 	client := meta.(*Owner).v3client
 	owner := meta.(*Owner).name
 	repository := d.Get("repository").(string)
-
 	ctx := context.Background()
-	opts := &github.ListOptions{
-		PerPage: maxPerPage,
-	}
 
 	d.SetId(repository)
 
-	allLabels := make([]interface{}, 0)
-	for {
-		labels, resp, err := client.Issues.ListLabels(ctx, owner, repository, opts)
-		if err != nil {
-			return err
-		}
-
-		result, err := flattenLabels(labels)
-		if err != nil {
-			return fmt.Errorf("unable to flatten GitHub Labels (Owner: %q/Repository: %q) : %+v", owner, repository, err)
-		}
-
-		allLabels = append(allLabels, result...)
-
-		if resp.NextPage == 0 {
-			break
-		}
-		opts.Page = resp.NextPage
+	labels, err := listLabels(client, ctx, owner, repository)
+	if err != nil {
+		return err
 	}
 
-	err := d.Set("labels", allLabels)
+	err = d.Set("labels", flattenLabels(labels))
 	if err != nil {
 		return err
 	}
 
 	return nil
 }
-
-func flattenLabels(labels []*github.Label) ([]interface{}, error) {
-	if labels == nil {
-		return make([]interface{}, 0), nil
-	}
-
-	results := make([]interface{}, 0)
-
-	for _, l := range labels {
-		result := make(map[string]interface{})
-
-		result["name"] = l.GetName()
-		result["color"] = l.GetColor()
-		result["description"] = l.GetDescription()
-		result["url"] = l.GetURL()
-
-		results = append(results, result)
-	}
-
-	return results, nil
-}

github/data_source_github_organization_custom_properties.go

@@ -0,0 +1,71 @@
+package github
+
+import (
+	"context"
+	"fmt"
+
+	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
+)
+
+func dataSourceGithubOrganizationCustomProperties() *schema.Resource {
+	return &schema.Resource{
+		Read: dataSourceGithubOrganizationCustomPropertiesRead,
+
+		Schema: map[string]*schema.Schema{
+			"property_name": {
+				Type:     schema.TypeString,
+				Required: true,
+			},
+			"value_type": {
+				Type:     schema.TypeString,
+				Optional: true,
+			},
+			"required": {
+				Type:     schema.TypeBool,
+				Optional: true,
+			},
+			"default_value": {
+				Type:     schema.TypeString,
+				Optional: true,
+				Computed: true,
+			},
+			"description": {
+				Type:     schema.TypeString,
+				Optional: true,
+				Computed: true,
+			},
+			"allowed_values": {
+				Type:     schema.TypeList,
+				Optional: true,
+				Computed: true,
+				Elem:     &schema.Schema{Type: schema.TypeString},
+			},
+		},
+	}
+}
+
+func dataSourceGithubOrganizationCustomPropertiesRead(d *schema.ResourceData, meta interface{}) error {
+	client := meta.(*Owner).v3client
+	ctx := context.Background()
+	orgName := meta.(*Owner).name
+
+	err := checkOrganization(meta)
+	if err != nil {
+		return err
+	}
+
+	propertyAttributes, _, err := client.Organizations.GetCustomProperty(ctx, orgName, d.Get("property_name").(string))
+	if err != nil {
+		return fmt.Errorf("error querying GitHub custom properties %s: %s", orgName, err)
+	}
+
+	d.SetId("org-custom-properties")
+	d.Set("allowed_values", propertyAttributes.AllowedValues)
+	d.Set("default_value", propertyAttributes.DefaultValue)
+	d.Set("description", propertyAttributes.Description)
+	d.Set("property_name", propertyAttributes.PropertyName)
+	d.Set("required", propertyAttributes.Required)
+	d.Set("value_type", propertyAttributes.ValueType)
+
+	return nil
+}

github/data_source_github_organization_custom_role.go

@@ -12,8 +12,9 @@ import (
 
 func dataSourceGithubOrganizationCustomRole() *schema.Resource {
 	return &schema.Resource{
-		Read: dataSourceGithubOrganizationCustomRoleRead,
+		DeprecationMessage: "This data source is deprecated and will be removed in a future release. Use the github_organization_repository_role data source instead.",
 
+		Read: dataSourceGithubOrganizationCustomRoleRead,
 		Schema: map[string]*schema.Schema{
 			"name": {
 				Type:     schema.TypeString,

github/data_source_github_organization_repository_role.go

@@ -0,0 +1,95 @@
+package github
+
+import (
+	"context"
+	"fmt"
+	"strconv"
+
+	"github.com/google/go-github/v66/github"
+	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
+)
+
+func dataSourceGithubOrganizationRepositoryRole() *schema.Resource {
+	return &schema.Resource{
+		Description: "Lookup a custom organization repository role.",
+
+		Read: dataSourceGithubOrganizationRepositoryRoleRead,
+
+		Schema: map[string]*schema.Schema{
+			"role_id": {
+				Description: "The ID of the organization repository role.",
+				Type:        schema.TypeInt,
+				Required:    true,
+			},
+			"name": {
+				Description: "The name of the organization repository role.",
+				Type:        schema.TypeString,
+				Computed:    true,
+			},
+			"description": {
+				Description: "The description of the organization repository role.",
+				Type:        schema.TypeString,
+				Computed:    true,
+			},
+			"base_role": {
+				Description: "The system role from which this role inherits permissions.",
+				Type:        schema.TypeString,
+				Computed:    true,
+			},
+			"permissions": {
+				Description: "The permissions included in this role.",
+				Type:        schema.TypeSet,
+				Elem:        &schema.Schema{Type: schema.TypeString},
+				Computed:    true,
+			},
+		},
+	}
+}
+
+func dataSourceGithubOrganizationRepositoryRoleRead(d *schema.ResourceData, meta interface{}) error {
+	client := meta.(*Owner).v3client
+	ctx := context.Background()
+	orgName := meta.(*Owner).name
+
+	roleId := int64(d.Get("role_id").(int))
+
+	// TODO: Use this code when go-github adds the functionality to get a custom repo role
+	// role, _, err := client.Organizations.GetCustomRepoRole(ctx, orgName, roleId)
+	// if err != nil {
+	// 	return err
+	// }
+
+	roles, _, err := client.Organizations.ListCustomRepoRoles(ctx, orgName)
+	if err != nil {
+		return err
+	}
+
+	var role *github.CustomRepoRoles
+	for _, r := range roles.CustomRepoRoles {
+		if r.GetID() == roleId {
+			role = r
+			break
+		}
+	}
+	if role == nil {
+		return fmt.Errorf("custom organization repo role with ID %d not found", roleId)
+	}
+
+	r := map[string]any{
+		"role_id":     role.GetID(),
+		"name":        role.GetName(),
+		"description": role.GetDescription(),
+		"base_role":   role.GetBaseRole(),
+		"permissions": role.Permissions,
+	}
+
+	d.SetId(strconv.FormatInt(role.GetID(), 10))
+
+	for k, v := range r {
+		if err := d.Set(k, v); err != nil {
+			return err
+		}
+	}
+
+	return nil
+}

github/data_source_github_organization_repository_role_test.go

@@ -0,0 +1,50 @@
+package github
+
+import (
+	"fmt"
+	"testing"
+
+	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/acctest"
+	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/resource"
+)
+
+func TestAccGithubOrganizationRepositoryRoleDataSource(t *testing.T) {
+	t.Run("queries an organization repository role", func(t *testing.T) {
+		randomID := acctest.RandStringFromCharSet(5, acctest.CharSetAlphaNum)
+		roleName := fmt.Sprintf(`tf-acc-test-%s`, randomID)
+
+		config := fmt.Sprintf(`
+			resource "github_organization_repository_role" "test" {
+				name        = "%s"
+				description = "Test role description"
+				base_role   = "read"
+				permissions = [
+					"reopen_issue",
+					"reopen_pull_request",
+				]
+			}
+
+			data "github_organization_repository_role" "test" {
+				role_id = github_organization_repository_role.test.role_id
+
+				depends_on = [ github_organization_repository_role.test ]
+			}
+		`, roleName)
+
+		resource.Test(t, resource.TestCase{
+			PreCheck:  func() { skipUnlessMode(t, enterprise) },
+			Providers: testAccProviders,
+			Steps: []resource.TestStep{
+				{
+					Config: config,
+					Check: resource.ComposeTestCheckFunc(
+						resource.TestCheckResourceAttrPair("data.github_organization_repository_role.test", "name", "github_organization_repository_role.test", "name"),
+						resource.TestCheckResourceAttrPair("data.github_organization_repository_role.test", "description", "github_organization_repository_role.test", "description"),
+						resource.TestCheckResourceAttrPair("data.github_organization_repository_role.test", "base_role", "github_organization_repository_role.test", "base_role"),
+						resource.TestCheckResourceAttrPair("data.github_organization_repository_role.test", "permissions.#", "github_organization_repository_role.test", "permissions.#"),
+					),
+				},
+			},
+		})
+	})
+}