Enhance documentation and tests for github_organization_network_configuration resource

Author: austenstone

github/resource_github_organization_network_configuration.go

@@ -49,7 +49,7 @@ func resourceGithubOrganizationNetworkConfiguration() *schema.Resource {
 				Elem: &schema.Schema{
 					Type: schema.TypeString,
 				},
-				Description: "The identifier of the network settings to use for the network configuration. Exactly one network settings must be specified.",
+				Description: "An array containing exactly one network settings ID. A network settings resource can only be associated with one network configuration at a time.",
 			},
 			"id": {
 				Type:        schema.TypeString,

github/resource_github_organization_network_configuration_test.go

@@ -12,7 +12,7 @@ func TestAccGithubOrganizationNetworkConfiguration(t *testing.T) {
 	t.Run("creates organization network configuration without error", func(t *testing.T) {
 		networkSettingsID := os.Getenv("GITHUB_TEST_NETWORK_SETTINGS_ID")
 		if networkSettingsID == "" {
-			t.Skip("Skipping test: GITHUB_TEST_NETWORK_SETTINGS_ID not set")
+			t.Skip("GITHUB_TEST_NETWORK_SETTINGS_ID not set")
 		}
 
 		config := fmt.Sprintf(`
@@ -74,15 +74,14 @@ func TestAccGithubOrganizationNetworkConfiguration(t *testing.T) {
 	t.Run("updates organization network configuration without error", func(t *testing.T) {
 		networkSettingsID := os.Getenv("GITHUB_TEST_NETWORK_SETTINGS_ID")
 		if networkSettingsID == "" {
-			t.Skip("Skipping test: GITHUB_TEST_NETWORK_SETTINGS_ID not set")
+			t.Skip("GITHUB_TEST_NETWORK_SETTINGS_ID not set")
 		}
 
 		name := "test-network-config-one"
 		computeService := "actions"
 
 		updatedName := "test-network-config-two"
 		updatedComputeService := "actions"
-		updatedNetworkSettingsID := networkSettingsID
 
 		configs := map[string]string{
 			"before": fmt.Sprintf(`
@@ -97,7 +96,7 @@ func TestAccGithubOrganizationNetworkConfiguration(t *testing.T) {
 				name                  = "%s"
 				compute_service       = "%s"
 				network_settings_ids  = ["%s"]
-			}`, updatedName, updatedComputeService, updatedNetworkSettingsID),
+			}`, updatedName, updatedComputeService, networkSettingsID),
 		}
 
 		checks := map[string]resource.TestCheckFunc{
@@ -126,7 +125,7 @@ func TestAccGithubOrganizationNetworkConfiguration(t *testing.T) {
 				),
 				resource.TestCheckResourceAttr(
 					"github_organization_network_configuration.test",
-					"network_settings_ids.0", updatedNetworkSettingsID,
+					"network_settings_ids.0", networkSettingsID,
 				),
 			),
 		}
@@ -164,7 +163,7 @@ func TestAccGithubOrganizationNetworkConfiguration(t *testing.T) {
 	t.Run("imports organization network configuration without error", func(t *testing.T) {
 		networkSettingsID := os.Getenv("GITHUB_TEST_NETWORK_SETTINGS_ID")
 		if networkSettingsID == "" {
-			t.Skip("Skipping test: GITHUB_TEST_NETWORK_SETTINGS_ID not set")
+			t.Skip("GITHUB_TEST_NETWORK_SETTINGS_ID not set")
 		}
 
 		name := "test-network-config-import"

website/docs/r/organization_network_configuration.html.markdown

@@ -0,0 +1,50 @@
+---
+layout: "github"
+page_title: "GitHub: github_organization_network_configuration"
+description: |-
+  Creates and manages network configurations for GitHub Actions hosted runners in an organization.
+---
+
+# github_organization_network_configuration
+
+This resource allows you to create and manage network configurations for GitHub Actions hosted runners in a GitHub Organization. Network configurations enable you to configure networking settings for hosted compute services.
+
+~> **Note:** This resource is only available for GitHub Enterprise Cloud organizations. See the [GitHub documentation](https://docs.github.com/en/enterprise-cloud@latest/rest/orgs/network-configurations) for more information.
+
+## Example Usage
+
+```hcl
+resource "github_organization_network_configuration" "example" {
+  name                 = "my-network-config"
+  compute_service      = "actions"
+  network_settings_ids = ["23456789ABDCEF1"]
+}
+```
+
+## Argument Reference
+
+The following arguments are supported:
+
+* `name` - (Required) The name of the network configuration. Must be between 1 and 100 characters and may only contain upper and lowercase letters a-z, numbers 0-9, '.', '-', and '_'.
+
+* `compute_service` - (Optional) The hosted compute service to use for the network configuration. Can be one of `none` or `actions`. Defaults to `none`.
+
+* `network_settings_ids` - (Required) An array containing exactly one network settings ID. Network settings resources are configured separately through your cloud provider (e.g., Azure). **Note:** A network settings resource can only be associated with one network configuration at a time.
+
+## Attributes Reference
+
+The following additional attributes are exported:
+
+* `id` - The ID of the network configuration.
+
+* `created_on` - The timestamp when the network configuration was created.
+
+## Import
+
+Organization network configurations can be imported using the network configuration ID:
+
+```
+$ terraform import github_organization_network_configuration.example 1234567890ABCDEF
+```
+
+The network configuration ID can be found using the [List network configurations](https://docs.github.com/en/enterprise-cloud@latest/rest/orgs/network-configurations#list-hosted-compute-network-configurations-for-an-organization) API endpoint.

website/github.erb

@@ -331,6 +331,9 @@
             <li>
               <a href="/docs/providers/github/r/organization_role_user.html">organization_role_user</a>
             </li>
+            <li>
+              <a href="/docs/providers/github/r/organization_network_configuration.html">github_organization_network_configuration</a>
+            </li>
             <li>
               <a href="/docs/providers/github/r/organization_ruleset.html">github_organization_ruleset</a>
             </li>