fix: Refactor repository custom property

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

Author: stevehipwell

ARCHITECTURE.md

@@ -178,7 +178,10 @@ func resourceGithubExample() *schema.Resource {
             StateContext: resourceGithubExampleImport,
         },
 
-        // Include SchemaVersion and StateUpgraders if state migrations exist
+        // Only if required.
+        CustomizeDiff: diffExample,
+
+        // Include SchemaVersion and StateUpgraders if state migrations exist.
         SchemaVersion: 1,
         StateUpgraders: []schema.StateUpgrader{
             {
@@ -188,8 +191,10 @@ func resourceGithubExample() *schema.Resource {
             },
         },
 
+        Description: "Manages an example GitHub resource.",
+
         Schema: map[string]*schema.Schema{
-            // Schema definition
+            // Schema definition.
         },
     }
 }

docs/resources/repository_custom_property.md

@@ -1,22 +1,25 @@
 ---
 page_title: "github_repository_custom_property (Resource) - GitHub"
+subcategory: ""
 description: |-
-  Creates and a specific custom property for a GitHub repository
+  Resource to manage GitHub repository custom properties.
 ---
 
 # github_repository_custom_property (Resource)
 
-This resource allows you to create and manage a specific custom property for a GitHub repository.
+Resource to manage GitHub repository custom properties.
+For more information, see the [GitHub API documentation](https://docs.github.com/rest/metadata/custom-properties#create-or-update-repository-custom-property).
 
 ## Example Usage
 
-> Note that this assumes there already is a custom property defined on the org level called `my-cool-property` of type `string`
-
 ```terraform
+# NOTE: This assumes there already is a custom property defined on the org level called `my-cool-property` of type `string`
+
 resource "github_repository" "example" {
   name        = "example"
   description = "My awesome codebase"
 }
+
 resource "github_repository_custom_property" "string" {
   repository     = github_repository.example.name
   property_name  = "my-cool-property"
@@ -25,21 +28,35 @@ resource "github_repository_custom_property" "string" {
 }
 ```
 
-## Argument Reference
+<!-- schema generated by tfplugindocs -->
+## Schema
 
-The following arguments are supported:
+### Required
 
-- `repository` - (Required) The repository of the environment.
+- `property_name` (String) Name of the custom property.
+- `property_type` (String) Type of the custom property. Valid values are `string`, `single_select`, `multi_select`, `true_false`, and `url`.
+- `property_value` (Set of String) Value of the custom property. For `string`, `single_select`, `true_false`, and `url` property types, this should be a single value. For `multi_select` property types, this can be multiple values.
+- `repository` (String) Name of the repository.
 
-- `property_type` - (Required) Type of the custom property. Can be one of `single_select`, `multi_select`, `string`, or `true_false`
+### Read-Only
 
-- `property_name` - (Required) Name of the custom property. Note that a pre-requisiste for this resource is that a custom property of this name has already been defined on the organization level
-
-- `property_value` - (Required) Value of the custom property in the form of an array. Properties of type `single_select`, `string`, and `true_false` are represented as a string array of length 1
+- `id` (String) The ID of this resource.
+- `repository_id` (Number) ID of the repository.
 
 ## Import
 
-GitHub Repository Custom Property can be imported using an ID made up of a combination of the names of the organization, repository, custom property separated by a `:` character, e.g.
+Import is supported using the following syntax:
+
+In Terraform v1.5.0 and later, the [`import` block](https://developer.hashicorp.com/terraform/language/import) can be used with the `id` attribute, for example:
+
+```terraform
+import {
+  to = github_repository_custom_property.example
+  id = "organization-name:repo-name:custom-property-name"
+}
+```
+
+The [`terraform import` command](https://developer.hashicorp.com/terraform/cli/commands/import) can be used, for example:
 
 ```shell
 terraform import github_repository_custom_property.example organization-name:repo-name:custom-property-name

examples/resources/github_repository_custom_property/import-by-string-id.tf

@@ -0,0 +1,4 @@
+import {
+  to = github_repository_custom_property.example
+  id = "organization-name:repo-name:custom-property-name"
+}

examples/resources/github_repository_custom_property/import.sh

@@ -0,0 +1 @@
+terraform import github_repository_custom_property.example organization-name:repo-name:custom-property-name

…/repository_custom_property/example_1.tf …repository_custom_property/resource_1.tfexamples/resources/repository_custom_property/example_1.tf renamed to examples/resources/github_repository_custom_property/resource_1.tf examples/resources/repository_custom_property/example_1.tf renamed to examples/resources/github_repository_custom_property/resource_1.tf

@@ -1,7 +1,10 @@
+# NOTE: This assumes there already is a custom property defined on the org level called `my-cool-property` of type `string`
+
 resource "github_repository" "example" {
   name        = "example"
   description = "My awesome codebase"
 }
+
 resource "github_repository_custom_property" "string" {
   repository     = github_repository.example.name
   property_name  = "my-cool-property"