feat: Add github_enterprise_custom_property data source (#3230)

Add a data source for reading enterprise custom property definitions,
complementing the new github_enterprise_custom_property resource.

Author: faradayfan

github/data_source_github_enterprise_custom_property.go

@@ -0,0 +1,84 @@
+package github
+
+import (
+	"context"
+
+	"github.com/hashicorp/terraform-plugin-sdk/v2/diag"
+	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
+)
+
+func dataSourceGithubEnterpriseCustomProperty() *schema.Resource {
+	return &schema.Resource{
+		ReadContext: dataSourceGithubEnterpriseCustomPropertyRead,
+
+		Schema: map[string]*schema.Schema{
+			"enterprise_slug": {
+				Type:        schema.TypeString,
+				Required:    true,
+				Description: "The slug of the enterprise.",
+			},
+			"property_name": {
+				Type:        schema.TypeString,
+				Required:    true,
+				Description: "The name of the custom property.",
+			},
+			"value_type": {
+				Type:        schema.TypeString,
+				Computed:    true,
+				Description: "The type of the value for the property.",
+			},
+			"required": {
+				Type:        schema.TypeBool,
+				Computed:    true,
+				Description: "Whether the custom property is required.",
+			},
+			"default_value": {
+				Type:        schema.TypeString,
+				Computed:    true,
+				Description: "The default value of the custom property.",
+			},
+			"description": {
+				Type:        schema.TypeString,
+				Computed:    true,
+				Description: "A short description of the custom property.",
+			},
+			"allowed_values": {
+				Type:        schema.TypeList,
+				Computed:    true,
+				Description: "An ordered list of allowed values for the property.",
+				Elem:        &schema.Schema{Type: schema.TypeString},
+			},
+			"values_editable_by": {
+				Type:        schema.TypeString,
+				Computed:    true,
+				Description: "Who can edit the values of the property. Can be one of 'org_actors' or 'org_and_repo_actors'.",
+			},
+		},
+	}
+}
+
+func dataSourceGithubEnterpriseCustomPropertyRead(ctx context.Context, d *schema.ResourceData, meta any) diag.Diagnostics {
+	client := meta.(*Owner).v3client
+
+	enterpriseSlug := d.Get("enterprise_slug").(string)
+	propertyName := d.Get("property_name").(string)
+
+	property, _, err := client.Enterprise.GetCustomProperty(ctx, enterpriseSlug, propertyName)
+	if err != nil {
+		return diag.Errorf("error reading enterprise custom property %s/%s: %v", enterpriseSlug, propertyName, err)
+	}
+
+	defaultValue, _ := property.DefaultValueString()
+
+	d.SetId(buildTwoPartID(enterpriseSlug, propertyName))
+	_ = d.Set("enterprise_slug", enterpriseSlug)
+	_ = d.Set("property_name", property.GetPropertyName())
+	_ = d.Set("value_type", string(property.ValueType))
+	_ = d.Set("required", property.GetRequired())
+	_ = d.Set("default_value", defaultValue)
+	_ = d.Set("description", property.GetDescription())
+	_ = d.Set("allowed_values", property.AllowedValues)
+	_ = d.Set("values_editable_by", property.GetValuesEditableBy())
+
+	return nil
+}

github/provider.go

@@ -295,6 +295,7 @@ func Provider() *schema.Provider {
 			"github_user_external_identity":                                         dataSourceGithubUserExternalIdentity(),
 			"github_users":                                                          dataSourceGithubUsers(),
 			"github_enterprise":                                                     dataSourceGithubEnterprise(),
+			"github_enterprise_custom_property":                                     dataSourceGithubEnterpriseCustomProperty(),
 			"github_repository_environment_deployment_policies":                     dataSourceGithubRepositoryEnvironmentDeploymentPolicies(),
 		},
 	}

website/docs/d/enterprise_custom_property.html.markdown

@@ -0,0 +1,59 @@
+---
+layout: "github"
+page_title: "GitHub: github_enterprise_custom_property"
+description: |-
+  Get information about a GitHub enterprise custom property definition
+---
+
+# github_enterprise_custom_property
+
+Use this data source to retrieve information about a custom property definition for a GitHub enterprise.
+
+## Example Usage
+
+```hcl
+data "github_enterprise_custom_property" "security_tier" {
+  enterprise_slug = "my-enterprise"
+  property_name   = "securityTier"
+}
+```
+
+## Example Usage - Reference in a Repository
+
+```hcl
+data "github_enterprise_custom_property" "security_tier" {
+  enterprise_slug = "my-enterprise"
+  property_name   = "securityTier"
+}
+
+resource "github_repository" "example" {
+  name       = "example"
+  visibility = "private"
+
+  custom_properties = {
+    (data.github_enterprise_custom_property.security_tier.property_name) = "tier1"
+  }
+}
+```
+
+## Argument Reference
+
+The following arguments are supported:
+
+* `enterprise_slug` - (Required) The slug of the enterprise.
+
+* `property_name` - (Required) The name of the custom property to retrieve.
+
+## Attributes Reference
+
+* `value_type` - The type of the value for the property. Can be one of `string`, `single_select`, `multi_select`, `true_false`, or `url`.
+
+* `required` - Whether the custom property is required on repositories.
+
+* `description` - A short description of the custom property.
+
+* `default_value` - The default value of the custom property.
+
+* `allowed_values` - An ordered list of allowed values for the property. Only populated when `value_type` is `single_select` or `multi_select`.
+
+* `values_editable_by` - Who can edit the values of the property. Can be one of `org_actors` or `org_and_repo_actors`.