Skip to content

Commit 2c6c045

Browse files
andrewesweetclaude
andcommitted
refactor: rename setting_value/policy_value to setting/policy
The _value suffix is redundant — every attribute is a value. Shorter names improve readability without losing clarity. Co-Authored-By: Claude Opus 4.7 (1M context) <[email protected]>
1 parent eb86ddc commit 2c6c045

3 files changed

Lines changed: 30 additions & 30 deletions

github/resource_github_enterprise_private_repository_forking_setting.go

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -22,14 +22,14 @@ func resourceGithubEnterprisePrivateRepositoryForkingSetting() *schema.Resource
2222
},
2323

2424
CustomizeDiff: func(_ context.Context, diff *schema.ResourceDiff, _ any) error {
25-
settingValue := diff.Get("setting_value").(string)
26-
policyValue := diff.Get("policy_value").(string)
25+
settingValue := diff.Get("setting").(string)
26+
policyValue := diff.Get("policy").(string)
2727

2828
if settingValue == "ENABLED" && policyValue == "" {
29-
return fmt.Errorf("policy_value is required when setting_value is ENABLED")
29+
return fmt.Errorf("policy is required when setting is ENABLED")
3030
}
3131
if settingValue != "ENABLED" && policyValue != "" {
32-
return fmt.Errorf("policy_value must not be set when setting_value is %s", settingValue)
32+
return fmt.Errorf("policy must not be set when setting is %s", settingValue)
3333
}
3434
return nil
3535
},
@@ -41,7 +41,7 @@ func resourceGithubEnterprisePrivateRepositoryForkingSetting() *schema.Resource
4141
ForceNew: true,
4242
Description: "The slug of the enterprise.",
4343
},
44-
"setting_value": {
44+
"setting": {
4545
Type: schema.TypeString,
4646
Required: true,
4747
ValidateDiagFunc: validation.ToDiagFunc(validation.StringInSlice([]string{
@@ -51,7 +51,7 @@ func resourceGithubEnterprisePrivateRepositoryForkingSetting() *schema.Resource
5151
}, false)),
5252
Description: "Whether private repository forking is enabled for the enterprise. Must be one of: ENABLED, DISABLED, NO_POLICY.",
5353
},
54-
"policy_value": {
54+
"policy": {
5555
Type: schema.TypeString,
5656
Optional: true,
5757
ValidateDiagFunc: validation.ToDiagFunc(validation.StringInSlice([]string{
@@ -62,7 +62,7 @@ func resourceGithubEnterprisePrivateRepositoryForkingSetting() *schema.Resource
6262
"USER_ACCOUNTS",
6363
"EVERYWHERE",
6464
}, false)),
65-
Description: "Where members can fork private repositories. Required when setting_value is ENABLED. Must be one of: ENTERPRISE_ORGANIZATIONS, SAME_ORGANIZATION, SAME_ORGANIZATION_USER_ACCOUNTS, ENTERPRISE_ORGANIZATIONS_USER_ACCOUNTS, USER_ACCOUNTS, EVERYWHERE.",
65+
Description: "Where members can fork private repositories. Required when setting is ENABLED. Must be one of: ENTERPRISE_ORGANIZATIONS, SAME_ORGANIZATION, SAME_ORGANIZATION_USER_ACCOUNTS, ENTERPRISE_ORGANIZATIONS_USER_ACCOUNTS, USER_ACCOUNTS, EVERYWHERE.",
6666
},
6767
},
6868
}
@@ -79,14 +79,14 @@ func resourceGithubEnterprisePrivateRepositoryForkingSettingCreateOrUpdate(d *sc
7979
return fmt.Errorf("error resolving enterprise ID for slug %q: %w", enterpriseSlug, err)
8080
}
8181

82-
settingValue := githubv4.EnterpriseEnabledDisabledSettingValue(d.Get("setting_value").(string))
82+
settingValue := githubv4.EnterpriseEnabledDisabledSettingValue(d.Get("setting").(string))
8383

8484
input := githubv4.UpdateEnterpriseAllowPrivateRepositoryForkingSettingInput{
8585
EnterpriseID: enterpriseID,
8686
SettingValue: settingValue,
8787
}
8888

89-
if v, ok := d.GetOk("policy_value"); ok {
89+
if v, ok := d.GetOk("policy"); ok {
9090
pv := githubv4.EnterpriseAllowPrivateRepositoryForkingPolicyValue(v.(string))
9191
input.PolicyValue = &pv
9292
}
@@ -141,16 +141,16 @@ func resourceGithubEnterprisePrivateRepositoryForkingSettingRead(d *schema.Resou
141141
}
142142

143143
settingValue := string(query.Enterprise.OwnerInfo.AllowPrivateRepositoryForkingSetting)
144-
if err := d.Set("setting_value", settingValue); err != nil {
144+
if err := d.Set("setting", settingValue); err != nil {
145145
return err
146146
}
147147

148148
if settingValue == "ENABLED" {
149-
if err := d.Set("policy_value", string(query.Enterprise.OwnerInfo.AllowPrivateRepositoryForkingSettingPolicyValue)); err != nil {
149+
if err := d.Set("policy", string(query.Enterprise.OwnerInfo.AllowPrivateRepositoryForkingSettingPolicyValue)); err != nil {
150150
return err
151151
}
152152
} else {
153-
if err := d.Set("policy_value", ""); err != nil {
153+
if err := d.Set("policy", ""); err != nil {
154154
return err
155155
}
156156
}

github/resource_github_enterprise_private_repository_forking_setting_test.go

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -15,24 +15,24 @@ func testAccEnterpriseForkingSettingConfig(settingValue, policyValue string) str
1515
return fmt.Sprintf(`
1616
resource "github_enterprise_private_repository_forking_setting" "test" {
1717
enterprise_slug = "%s"
18-
setting_value = "%s"
19-
policy_value = "%s"
18+
setting = "%s"
19+
policy = "%s"
2020
}
2121
`, testAccConf.enterpriseSlug, settingValue, policyValue)
2222
}
2323
return fmt.Sprintf(`
2424
resource "github_enterprise_private_repository_forking_setting" "test" {
2525
enterprise_slug = "%s"
26-
setting_value = "%s"
26+
setting = "%s"
2727
}
2828
`, testAccConf.enterpriseSlug, settingValue)
2929
}
3030

3131
func testAccEnterpriseForkingSettingCheck(settingValue, policyValue string) resource.TestCheckFunc {
3232
return resource.ComposeTestCheckFunc(
3333
resource.TestCheckResourceAttr(testAccEnterpriseForkingSettingResource, "enterprise_slug", testAccConf.enterpriseSlug),
34-
resource.TestCheckResourceAttr(testAccEnterpriseForkingSettingResource, "setting_value", settingValue),
35-
resource.TestCheckResourceAttr(testAccEnterpriseForkingSettingResource, "policy_value", policyValue),
34+
resource.TestCheckResourceAttr(testAccEnterpriseForkingSettingResource, "setting", settingValue),
35+
resource.TestCheckResourceAttr(testAccEnterpriseForkingSettingResource, "policy", policyValue),
3636
)
3737
}
3838

@@ -110,27 +110,27 @@ func TestAccGithubEnterprisePrivateRepositoryForkingSetting(t *testing.T) {
110110
})
111111
})
112112

113-
t.Run("rejects policy_value when disabled", func(t *testing.T) {
113+
t.Run("rejects policy when disabled", func(t *testing.T) {
114114
resource.Test(t, resource.TestCase{
115115
PreCheck: func() { skipUnlessEnterprise(t) },
116116
ProviderFactories: providerFactories,
117117
Steps: []resource.TestStep{
118118
{
119119
Config: testAccEnterpriseForkingSettingConfig("DISABLED", "SAME_ORGANIZATION"),
120-
ExpectError: regexp.MustCompile(`policy_value must not be set when setting_value is DISABLED`),
120+
ExpectError: regexp.MustCompile(`policy must not be set when setting is DISABLED`),
121121
},
122122
},
123123
})
124124
})
125125

126-
t.Run("requires policy_value when enabled", func(t *testing.T) {
126+
t.Run("requires policy when enabled", func(t *testing.T) {
127127
resource.Test(t, resource.TestCase{
128128
PreCheck: func() { skipUnlessEnterprise(t) },
129129
ProviderFactories: providerFactories,
130130
Steps: []resource.TestStep{
131131
{
132132
Config: testAccEnterpriseForkingSettingConfig("ENABLED", ""),
133-
ExpectError: regexp.MustCompile(`policy_value is required when setting_value is ENABLED`),
133+
ExpectError: regexp.MustCompile(`policy is required when setting is ENABLED`),
134134
},
135135
},
136136
})

website/docs/r/enterprise_private_repository_forking_setting.html.markdown

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ description: |-
1010
This resource allows you to create and manage the private repository forking policy for a GitHub Enterprise.
1111
You must have enterprise admin access to use this resource.
1212

13-
When `setting_value` is `ENABLED`, the `policy_value` attribute controls where forks
13+
When `setting` is `ENABLED`, the `policy` attribute controls where forks
1414
can be created. When `DISABLED`, forking of private repositories is not allowed.
1515
When `NO_POLICY`, individual organizations within the enterprise control their own
1616
forking settings.
@@ -22,8 +22,8 @@ forking settings.
2222
```hcl
2323
resource "github_enterprise_private_repository_forking_setting" "example" {
2424
enterprise_slug = "my-enterprise"
25-
setting_value = "ENABLED"
26-
policy_value = "SAME_ORGANIZATION"
25+
setting = "ENABLED"
26+
policy = "SAME_ORGANIZATION"
2727
}
2828
```
2929

@@ -32,8 +32,8 @@ resource "github_enterprise_private_repository_forking_setting" "example" {
3232
```hcl
3333
resource "github_enterprise_private_repository_forking_setting" "example" {
3434
enterprise_slug = "my-enterprise"
35-
setting_value = "ENABLED"
36-
policy_value = "ENTERPRISE_ORGANIZATIONS_USER_ACCOUNTS"
35+
setting = "ENABLED"
36+
policy = "ENTERPRISE_ORGANIZATIONS_USER_ACCOUNTS"
3737
}
3838
```
3939

@@ -42,7 +42,7 @@ resource "github_enterprise_private_repository_forking_setting" "example" {
4242
```hcl
4343
resource "github_enterprise_private_repository_forking_setting" "example" {
4444
enterprise_slug = "my-enterprise"
45-
setting_value = "DISABLED"
45+
setting = "DISABLED"
4646
}
4747
```
4848

@@ -51,7 +51,7 @@ resource "github_enterprise_private_repository_forking_setting" "example" {
5151
```hcl
5252
resource "github_enterprise_private_repository_forking_setting" "example" {
5353
enterprise_slug = "my-enterprise"
54-
setting_value = "NO_POLICY"
54+
setting = "NO_POLICY"
5555
}
5656
```
5757

@@ -60,8 +60,8 @@ resource "github_enterprise_private_repository_forking_setting" "example" {
6060
The following arguments are supported:
6161

6262
* `enterprise_slug` - (Required) The slug of the enterprise.
63-
* `setting_value` - (Required) Whether private repository forking is enabled for the enterprise. Must be one of `ENABLED`, `DISABLED`, or `NO_POLICY`.
64-
* `policy_value` - (Optional) Where members can fork private repositories. Required when `setting_value` is `ENABLED`. Must be one of:
63+
* `setting` - (Required) Whether private repository forking is enabled for the enterprise. Must be one of `ENABLED`, `DISABLED`, or `NO_POLICY`.
64+
* `policy` - (Optional) Where members can fork private repositories. Required when `setting` is `ENABLED`. Must be one of:
6565
* `ENTERPRISE_ORGANIZATIONS` - Members can fork to an organization within this enterprise.
6666
* `SAME_ORGANIZATION` - Members can fork only within the same organization (intra-org).
6767
* `SAME_ORGANIZATION_USER_ACCOUNTS` - Members can fork to their user account or within the same organization.

0 commit comments

Comments
 (0)