fix: Restore Optional on etag fields — required by SDK for DiffSuppressFunc

ei-grad · claude · ei-grad · commit 97001abf0a8e · 2026-04-01T10:10:54.000+03:00
The terraform-plugin-sdk v2 InternalValidate rejects DiffSuppressFunc
on Computed-only fields with: "There is no config for computed-only
field, nothing to compare." Optional: true is required to use
DiffSuppressFunc, as demonstrated by the new tests.

Co-Authored-By: Claude &lt;noreply@anthropic.com&gt;
diff --git a/github/resource_github_actions_runner_group.go b/github/resource_github_actions_runner_group.go
@@ -42,6 +42,7 @@ func resourceGithubActionsRunnerGroup() *schema.Resource {
 			},
 			"etag": {
 				Type:        schema.TypeString,
+				Optional:    true,
 				Computed:    true,
 				Description: "An etag representing the runner group object",
 				DiffSuppressFunc: func(k, o, n string, d *schema.ResourceData) bool {
diff --git a/github/resource_github_branch.go b/github/resource_github_branch.go
@@ -50,6 +50,7 @@ func resourceGithubBranch() *schema.Resource {
 			},
 			"etag": {
 				Type:        schema.TypeString,
+				Optional:    true,
 				Computed:    true,
 				Description: "An etag representing the Branch object.",
 				DiffSuppressFunc: func(k, o, n string, d *schema.ResourceData) bool {
diff --git a/github/resource_github_branch_default.go b/github/resource_github_branch_default.go
@@ -40,6 +40,7 @@ func resourceGithubBranchDefault() *schema.Resource {
 			},
 			"etag": {
 				Type:     schema.TypeString,
+				Optional: true,
 				Computed: true,
 				DiffSuppressFunc: func(k, o, n string, d *schema.ResourceData) bool {
 					return true
diff --git a/github/resource_github_branch_protection_v3.go b/github/resource_github_branch_protection_v3.go
@@ -213,6 +213,7 @@ func resourceGithubBranchProtectionV3() *schema.Resource {
 			},
 			"etag": {
 				Type:     schema.TypeString,
+				Optional: true,
 				Computed: true,
 				DiffSuppressFunc: func(k, o, n string, d *schema.ResourceData) bool {
 					return true
diff --git a/github/resource_github_emu_group_mapping.go b/github/resource_github_emu_group_mapping.go
@@ -46,6 +46,7 @@ func resourceGithubEMUGroupMapping() *schema.Resource {
 			},
 			"etag": {
 				Type:     schema.TypeString,
+				Optional: true,
 				Computed: true,
 				DiffSuppressFunc: func(k, o, n string, d *schema.ResourceData) bool {
 					return true
diff --git a/github/resource_github_enterprise_actions_runner_group.go b/github/resource_github_enterprise_actions_runner_group.go
@@ -43,6 +43,7 @@ func resourceGithubActionsEnterpriseRunnerGroup() *schema.Resource {
 			},
 			"etag": {
 				Type:        schema.TypeString,
+				Optional:    true,
 				Computed:    true,
 				Description: "An etag representing the runner group object",
 				DiffSuppressFunc: func(k, o, n string, d *schema.ResourceData) bool {
diff --git a/github/resource_github_etag_unit_test.go b/github/resource_github_etag_unit_test.go
@@ -168,7 +168,11 @@ func TestEtagSchemaConsistency(t *testing.T) {
 				return
 			}
 
-			// Verify etag is computed
+			// Verify etag is optional+computed (Optional is required by the SDK
+			// for DiffSuppressFunc, see TestEtagComputedOnlyRejectsSuppress)
+			if !etagField.Optional {
+				t.Errorf("etag should be optional in %s", resourceName)
+			}
 			if !etagField.Computed {
 				t.Errorf("etag should be computed in %s", resourceName)
 			}
diff --git a/github/resource_github_issue.go b/github/resource_github_issue.go
@@ -69,6 +69,7 @@ func resourceGithubIssue() *schema.Resource {
 			},
 			"etag": {
 				Type:     schema.TypeString,
+				Optional: true,
 				Computed: true,
 				DiffSuppressFunc: func(k, o, n string, d *schema.ResourceData) bool {
 					return true
diff --git a/github/resource_github_issue_label.go b/github/resource_github_issue_label.go
@@ -49,6 +49,7 @@ func resourceGithubIssueLabel() *schema.Resource {
 			},
 			"etag": {
 				Type:     schema.TypeString,
+				Optional: true,
 				Computed: true,
 				DiffSuppressFunc: func(k, o, n string, d *schema.ResourceData) bool {
 					return true
diff --git a/github/resource_github_membership.go b/github/resource_github_membership.go
@@ -39,6 +39,7 @@ func resourceGithubMembership() *schema.Resource {
 			},
 			"etag": {
 				Type:     schema.TypeString,
+				Optional: true,
 				Computed: true,
 				DiffSuppressFunc: func(k, o, n string, d *schema.ResourceData) bool {
 					return true
diff --git a/github/resource_github_organization_project.go b/github/resource_github_organization_project.go
@@ -36,6 +36,7 @@ func resourceGithubOrganizationProject() *schema.Resource {
 			},
 			"etag": {
 				Type:     schema.TypeString,
+				Optional: true,
 				Computed: true,
 				DiffSuppressFunc: func(k, o, n string, d *schema.ResourceData) bool {
 					return true
diff --git a/github/resource_github_organization_ruleset.go b/github/resource_github_organization_ruleset.go
@@ -675,6 +675,7 @@ func resourceGithubOrganizationRuleset() *schema.Resource {
 			},
 			"etag": {
 				Type:        schema.TypeString,
+				Optional:    true,
 				Computed:    true,
 				Description: "An etag representing the ruleset for caching purposes.",
 				DiffSuppressFunc: func(k, o, n string, d *schema.ResourceData) bool {
diff --git a/github/resource_github_organization_webhook.go b/github/resource_github_organization_webhook.go
@@ -53,6 +53,7 @@ func resourceGithubOrganizationWebhook() *schema.Resource {
 			},
 			"etag": {
 				Type:     schema.TypeString,
+				Optional: true,
 				Computed: true,
 				DiffSuppressFunc: func(k, o, n string, d *schema.ResourceData) bool {
 					return true
diff --git a/github/resource_github_project_card.go b/github/resource_github_project_card.go
@@ -41,6 +41,7 @@ func resourceGithubProjectCard() *schema.Resource {
 			},
 			"etag": {
 				Type:     schema.TypeString,
+				Optional: true,
 				Computed: true,
 				DiffSuppressFunc: func(k, o, n string, d *schema.ResourceData) bool {
 					return true
diff --git a/github/resource_github_project_column.go b/github/resource_github_project_column.go
@@ -37,6 +37,7 @@ func resourceGithubProjectColumn() *schema.Resource {
 			},
 			"etag": {
 				Type:     schema.TypeString,
+				Optional: true,
 				Computed: true,
 				DiffSuppressFunc: func(k, o, n string, d *schema.ResourceData) bool {
 					return true
diff --git a/github/resource_github_release.go b/github/resource_github_release.go
@@ -82,6 +82,7 @@ func resourceGithubRelease() *schema.Resource {
 			},
 			"etag": {
 				Type:     schema.TypeString,
+				Optional: true,
 				Computed: true,
 				DiffSuppressFunc: func(k, o, n string, d *schema.ResourceData) bool {
 					return true
diff --git a/github/resource_github_repository.go b/github/resource_github_repository.go
@@ -439,6 +439,7 @@ func resourceGithubRepository() *schema.Resource {
 			},
 			"etag": {
 				Type:     schema.TypeString,
+				Optional: true,
 				Computed: true,
 				DiffSuppressFunc: func(k, o, n string, d *schema.ResourceData) bool {
 					return true
diff --git a/github/resource_github_repository_autolink_reference.go b/github/resource_github_repository_autolink_reference.go
@@ -86,6 +86,7 @@ func resourceGithubRepositoryAutolinkReference() *schema.Resource {
 			},
 			"etag": {
 				Type:     schema.TypeString,
+				Optional: true,
 				Computed: true,
 				DiffSuppressFunc: func(k, o, n string, d *schema.ResourceData) bool {
 					return true
diff --git a/github/resource_github_repository_deploy_key.go b/github/resource_github_repository_deploy_key.go
@@ -52,6 +52,7 @@ func resourceGithubRepositoryDeployKey() *schema.Resource {
 			},
 			"etag": {
 				Type:     schema.TypeString,
+				Optional: true,
 				Computed: true,
 				DiffSuppressFunc: func(k, o, n string, d *schema.ResourceData) bool {
 					return true
diff --git a/github/resource_github_repository_deployment_branch_policy.go b/github/resource_github_repository_deployment_branch_policy.go
@@ -43,6 +43,7 @@ func resourceGithubRepositoryDeploymentBranchPolicy() *schema.Resource {
 			},
 			"etag": {
 				Type:        schema.TypeString,
+				Optional:    true,
 				Computed:    true,
 				Description: "An etag representing the Branch object.",
 				DiffSuppressFunc: func(k, o, n string, d *schema.ResourceData) bool {
diff --git a/github/resource_github_repository_project.go b/github/resource_github_repository_project.go
@@ -53,6 +53,7 @@ func resourceGithubRepositoryProject() *schema.Resource {
 			},
 			"etag": {
 				Type:     schema.TypeString,
+				Optional: true,
 				Computed: true,
 				DiffSuppressFunc: func(k, o, n string, d *schema.ResourceData) bool {
 					return true
diff --git a/github/resource_github_repository_ruleset.go b/github/resource_github_repository_ruleset.go
@@ -678,6 +678,7 @@ func resourceGithubRepositoryRuleset() *schema.Resource {
 			},
 			"etag": {
 				Type:     schema.TypeString,
+				Optional: true,
 				Computed: true,
 				DiffSuppressFunc: func(k, o, n string, d *schema.ResourceData) bool {
 					return true
diff --git a/github/resource_github_repository_webhook.go b/github/resource_github_repository_webhook.go
@@ -71,6 +71,7 @@ func resourceGithubRepositoryWebhook() *schema.Resource {
 			},
 			"etag": {
 				Type:     schema.TypeString,
+				Optional: true,
 				Computed: true,
 				DiffSuppressFunc: func(k, o, n string, d *schema.ResourceData) bool {
 					return true
diff --git a/github/resource_github_team.go b/github/resource_github_team.go
@@ -106,6 +106,7 @@ func resourceGithubTeam() *schema.Resource {
 			},
 			"etag": {
 				Type:     schema.TypeString,
+				Optional: true,
 				Computed: true,
 				DiffSuppressFunc: func(k, o, n string, d *schema.ResourceData) bool {
 					return true
diff --git a/github/resource_github_team_membership.go b/github/resource_github_team_membership.go
@@ -57,6 +57,7 @@ func resourceGithubTeamMembership() *schema.Resource {
 			},
 			"etag": {
 				Type:     schema.TypeString,
+				Optional: true,
 				Computed: true,
 				DiffSuppressFunc: func(k, o, n string, d *schema.ResourceData) bool {
 					return true
diff --git a/github/resource_github_team_repository.go b/github/resource_github_team_repository.go
@@ -56,6 +56,7 @@ func resourceGithubTeamRepository() *schema.Resource {
 			},
 			"etag": {
 				Type:     schema.TypeString,
+				Optional: true,
 				Computed: true,
 				DiffSuppressFunc: func(k, o, n string, d *schema.ResourceData) bool {
 					return true
diff --git a/github/resource_github_team_sync_group_mapping.go b/github/resource_github_team_sync_group_mapping.go
@@ -60,6 +60,7 @@ func resourceGithubTeamSyncGroupMapping() *schema.Resource {
 			},
 			"etag": {
 				Type:     schema.TypeString,
+				Optional: true,
 				Computed: true,
 				DiffSuppressFunc: func(k, o, n string, d *schema.ResourceData) bool {
 					return true
diff --git a/github/resource_github_user_gpg_key.go b/github/resource_github_user_gpg_key.go
@@ -31,6 +31,7 @@ func resourceGithubUserGpgKey() *schema.Resource {
 			},
 			"etag": {
 				Type:     schema.TypeString,
+				Optional: true,
 				Computed: true,
 				DiffSuppressFunc: func(k, o, n string, d *schema.ResourceData) bool {
 					return true
diff --git a/github/resource_github_user_ssh_key.go b/github/resource_github_user_ssh_key.go
@@ -45,6 +45,7 @@ func resourceGithubUserSshKey() *schema.Resource {
 			},
 			"etag": {
 				Type:     schema.TypeString,
+				Optional: true,
 				Computed: true,
 				DiffSuppressFunc: func(k, o, n string, d *schema.ResourceData) bool {
 					return true
diff --git a/github/resource_organization_block.go b/github/resource_organization_block.go
@@ -29,6 +29,7 @@ func resourceOrganizationBlock() *schema.Resource {
 
 			"etag": {
 				Type:     schema.TypeString,
+				Optional: true,
 				Computed: true,
 				DiffSuppressFunc: func(k, o, n string, d *schema.ResourceData) bool {
 					return true

Original file line number	Diff line number	Diff line change
`@@ -168,7 +168,11 @@ func TestEtagSchemaConsistency(t *testing.T) {`
`168`	`168`	`return`
`169`	`169`	`}`
`170`	`170`
`171`		`- // Verify etag is computed`
	`171`	`+ // Verify etag is optional+computed (Optional is required by the SDK`
	`172`	`+ // for DiffSuppressFunc, see TestEtagComputedOnlyRejectsSuppress)`
	`173`	`+ if !etagField.Optional {`
	`174`	`+ t.Errorf("etag should be optional in %s", resourceName)`
	`175`	`+ }`
`172`	`176`	`if !etagField.Computed {`
`173`	`177`	`t.Errorf("etag should be computed in %s", resourceName)`
`174`	`178`	`}`