[MAINT] Modernize `github_repository` resource by deiga · Pull Request #3310 · integrations/terraform-provider-github

deiga · 2026-03-28T18:40:33Z

Resolves #2604
Resolves #2264
Resolves #3302
Resolves #3562
Resolves #3554
Resolves #3592
Addresses many parts of #3133
Addresses #3070

Before the change?

Tests used legacy testing checks
Tests weren't being run in parallel
Resource was still using log
There was an deprecated gate against archived in the Read func
Create would call Update and Update would call Read which is an anti-pattern

After the change?

Ensure that each CRUD function is fully self-contained
Tests use modern ConfigStateChecks
Tests can run in parallel, which reduces time to run tests immensely
Logging has been refactored to use tflog
After verification the "if not archived" gate in Read could be removed
Updates the resource and data-source docs to use template generation
Enable some resource tests that needed Org settings changes
Adds web_commit_signoff_required computed attribute to data-source
Adds timeouts to resource operations
Adds deprecation warning to topics attribute in resource
Adds validation that correct settings for allow_squash_merge and allow_commit_merge are set

Pull request checklist

~~Schema migrations have been created if needed (example)~~
Tests for the changes have been added (for bug fixes / features)
Docs have been reviewed and added / updated if needed (for bug fixes / features)

Does this introduce a breaking change?

Please see our docs on breaking changes to help!

Yes
No

github-actions · 2026-03-28T18:40:45Z

👋 Hi! Thank you for this contribution! Just to let you know, our GitHub SDK team does a round of issue and PR reviews twice a week, every Monday and Friday! We have a process in place for prioritizing and responding to your input. Because you are a part of this community please feel free to comment, add to, or pick up any issues/PRs that are labeled with Status: Up for grabs. You & others like you are the reason all of this works! So thank you & happy coding! 🚀

Copilot

Pull request overview

These provider review instructions are being used. This PR modernizes the github_repository resource by refactoring CRUD behavior, migrating logging to tflog, updating repository documentation, and modernizing acceptance tests to use ConfigStateChecks and run in parallel.

Changes:

Refactors github_repository CRUD flow to be more self-contained and centralizes state population via a helper.
Migrates github_repository acceptance tests to resource.ParallelTest + ConfigStateChecks and expands coverage for merge-strategy validation.
Updates docs/templates for deprecated private, exported etag, and Pages attribute descriptions; adds web_commit_signoff_required to the repository data source.

Reviewed changes

Copilot reviewed 6 out of 6 changed files in this pull request and generated 3 comments.

Show a summary per file

File	Description
`github/resource_github_repository.go`	Moves repository state-setting into `setResourceFieldsFromRepo`, refactors create/update/read flows, adds custom diff validation for conflicting merge settings, and migrates logging to `tflog`.
`github/resource_github_repository_test.go`	Converts acceptance tests to `resource.ParallelTest` and `ConfigStateChecks`, adds coverage for merge/squash strategy validation.
`github/data_source_github_repository.go`	Adds computed `web_commit_signoff_required` to the repository data source schema and read.
`GNUmakefile`	Runs acceptance tests with a parallelism cap to support parallelized test cases.
`templates/resources/repository.md.tmpl`	Updates generated doc template to reflect deprecations/exports and Pages field descriptions.
`docs/resources/repository.md`	Updates generated docs to match the template changes (deprecated `private`, `etag`, Pages fields, etc.).

Copilot

Pull request overview

Copilot reviewed 8 out of 10 changed files in this pull request and generated 5 comments.

Copilot

Pull request overview

Copilot reviewed 11 out of 14 changed files in this pull request and generated 5 comments.

Copilot

Pull request overview

Copilot reviewed 12 out of 15 changed files in this pull request and generated 8 comments.

+		if err != nil {
+			if ghErr, ok := errors.AsType[*github.ErrorResponse](err); ok {
+				if ghErr.Response.StatusCode == http.StatusUnprocessableEntity && strings.Contains(ghErr.Error(), "A previous repository operation is still in progress") {
+					tflog.Debug(ctx, "Repository is still being created, retrying PATCH", map[string]any{"owner": owner, "name": repoName})
+					return retry.RetryableError(fmt.Errorf("repository is still being created, retrying PATCH"))
+				}
+				return retry.NonRetryableError(fmt.Errorf("Error editing repository: %w", err))
+			}
+		}
+		return nil


 	}

-	return resourceGithubRepositoryRead(ctx, d, meta)
+	if diags := setResourceFieldsFromRepo(ctx, d, client, owner, repo); diags.HasError() {


 			"pages": {
-				Type:       schema.TypeList,
-				Computed:   true,
-				Deprecated: "Use the github_repository_pages data source instead. This field will be removed in a future version.",
+				Type:        schema.TypeList,
+				Computed:    true,
+				Deprecated:  "Use the github_repository_pages data source instead. This field will be removed in a future version.",
+				Description: "The repository's GitHub Pages configuration. Use the `github_repository_pages` data source instead. This field will be removed in a future version.",


 )

 func TestAccGithubRepository(t *testing.T) {
 	t.Parallel()


-
-		t.Skip("This test should be run manually after confirming that the test organization has 'Require contributors to sign off on web-based commits' enabled under Organizations -> Settings -> Repository -> Repository defaults.")
+		// This test can't be run in parallel because it modifies the organization settings, which could affect other tests.
+		mustRequireWebCommitSignoffForOrganization(t, testAccConf.owner)


-
-		t.Skip("This test should be run manually after confirming that the test organization has been correctly configured to disable setting forking at the repo level.")
+		// This test can't be run in parallel because it modifies the organization settings, which could affect other tests.
+		mustDisableForkingForOrganization(t, testAccConf.owner)


 				{
 					Config: fmt.Sprintf(config, testRepoName, "foo"),
-					Check: resource.ComposeTestCheckFunc(
-						resource.TestCheckResourceAttr("github_repository.private", "allow_forking", "false"),
-					),
-				},
-				{
-					Config: fmt.Sprintf(config, testRepoName, "bar"),
+					ConfigStateChecks: []statecheck.StateCheck{
+						statecheck.ExpectKnownValue("github_repository.private", tfjsonpath.New("allow_forking"), knownvalue.Bool(false)),
+					},


+// setResourceFieldsFromRepo populates all Computed schema fields
+// from a *github.Repository API response.
+// For fields requiring separate API calls (pages, vulnerability alerts), targeted calls are made here.
+func setResourceFieldsFromRepo(ctx context.Context, d *schema.ResourceData, client *github.Client, owner string, repo *github.Repository) diag.Diagnostics {


`RequiredWith` doesn't work with `Default` values Signed-off-by: Timo Sand <timo.sand@f-secure.com>

Signed-off-by: Timo Sand <timo.sand@f-secure.com>

This ensures that Visibility changes work properly even for internal repos created from Templates Signed-off-by: Timo Sand <timo.sand@f-secure.com>

… not provider Signed-off-by: Timo Sand <timo.sand@f-secure.com>

Signed-off-by: Timo Sand <timo.sand@f-secure.com>

…nown at diff time Signed-off-by: Timo Sand <timo.sand@f-secure.com>

Signed-off-by: Timo Sand <timo.sand@f-secure.com>

rilical

There are two state-behavior changes here that I think need either coverage or clearer deprecation handling. The PR removes the request and Read wiring for has_downloads, but the schema and generated docs still present it as a usable argument, so configurations can now set a value that is silently ignored. It also removes the archived-repository guard around several merge and forking fields even though the old code noted that GitHub may omit those values after archival. Could we either preserve the existing behavior or make the new behavior explicit, then add focused tests for both cases?

deiga requested a review from stevehipwell March 28, 2026 18:41

deiga marked this pull request as draft March 28, 2026 19:02

deiga marked this pull request as ready for review March 30, 2026 06:06

deiga added the Type: Maintenance Any dependency, housekeeping, and clean up Issue or PR label Apr 19, 2026

This comment was marked as outdated.

Sign in to view

deiga added r/repository vNext labels May 10, 2026

deiga force-pushed the refactor-github-repository branch from 0b52c2c to 9f55dad Compare May 11, 2026 01:43

deiga marked this pull request as draft May 14, 2026 21:10

deiga removed the request for review from stevehipwell May 17, 2026 13:22

deiga force-pushed the refactor-github-repository branch from 9f55dad to e40af83 Compare May 24, 2026 12:47

deiga force-pushed the refactor-github-repository branch from e40af83 to 57e9be8 Compare June 3, 2026 06:55

deiga requested a review from Copilot June 3, 2026 06:55

Copilot started reviewing on behalf of deiga June 3, 2026 06:56 View session

Copilot AI reviewed Jun 3, 2026

View reviewed changes

Comment thread github/resource_github_repository.go

Comment thread github/resource_github_repository.go

Comment thread github/resource_github_repository_test.go Outdated

deiga force-pushed the refactor-github-repository branch from 57e9be8 to c43f69e Compare July 10, 2026 10:35

deiga requested a review from Copilot July 10, 2026 10:36

Copilot started reviewing on behalf of deiga July 10, 2026 10:36 View session

Copilot AI reviewed Jul 10, 2026

View reviewed changes

Comment thread github/resource_github_repository.go Outdated

Comment thread github/resource_github_repository.go Outdated

Comment thread github/resource_github_repository.go Outdated

Comment thread github/resource_github_repository.go

Comment thread github/data_source_github_repository.go

deiga force-pushed the refactor-github-repository branch from c43f69e to 4c9a812 Compare July 11, 2026 18:54

deiga requested a review from Copilot July 12, 2026 19:49

deiga marked this pull request as ready for review July 12, 2026 19:49

deiga requested a review from stevehipwell July 12, 2026 19:49

Copilot started reviewing on behalf of deiga July 12, 2026 19:49 View session

Copilot AI reviewed Jul 12, 2026

View reviewed changes

Comment thread github/resource_github_repository.go Outdated

Comment thread github/resource_github_repository.go Outdated

Comment thread github/resource_github_repository.go Outdated

Comment thread github/data_source_github_repository.go

Comment thread github/resource_github_repository_test.go

deiga force-pushed the refactor-github-repository branch from 6fc8411 to 53fac2d Compare July 13, 2026 19:59

deiga requested a review from Copilot July 14, 2026 10:11

Copilot started reviewing on behalf of deiga July 14, 2026 10:11 View session

Copilot AI reviewed Jul 14, 2026

View reviewed changes

deiga added 28 commits August 22, 2026 14:25

Refactor to use only CustomizeDiff for validation

72b2fb6

`RequiredWith` doesn't work with `Default` values Signed-off-by: Timo Sand <timo.sand@f-secure.com>

Improve structure of setResourceFieldsFromRepo

57a9a27

Signed-off-by: Timo Sand <timo.sand@f-secure.com>

Cleaning some tests

41165fe

Signed-off-by: Timo Sand <timo.sand@f-secure.com>

Enable primary_language test

5f0b115

Signed-off-by: Timo Sand <timo.sand@f-secure.com>

Fix linter issues

62efa13

Signed-off-by: Timo Sand <timo.sand@f-secure.com>

Update docs to use generated content

f36229f

Signed-off-by: Timo Sand <timo.sand@f-secure.com>

Fix docs check

c1f4e0e

Signed-off-by: Timo Sand <timo.sand@f-secure.com>

Fix duplicate resource naming

2c4425d

Signed-off-by: Timo Sand <timo.sand@f-secure.com>

Remove all calls to resource.ParallelTest

7dc8176

Signed-off-by: Timo Sand <timo.sand@f-secure.com>

Try to ensure test is not flaky

97e3164

Signed-off-by: Timo Sand <timo.sand@f-secure.com>

Rename tests to snake case

db451f2

Signed-off-by: Timo Sand <timo.sand@f-secure.com>

Address review comments

34cc011

Signed-off-by: Timo Sand <timo.sand@f-secure.com>

Update docs for repository data-source

5854295

Signed-off-by: Timo Sand <timo.sand@f-secure.com>

Refactor errors.As to errors.AsType

cbf14ff

Signed-off-by: Timo Sand <timo.sand@f-secure.com>

Add test helper for creating template repositories

4819d53

Signed-off-by: Timo Sand <timo.sand@f-secure.com>

Fix config indentation

7adcd23

Signed-off-by: Timo Sand <timo.sand@f-secure.com>

Add retry to the Edit API call in Create

76d8dd5

This ensures that Visibility changes work properly even for internal repos created from Templates Signed-off-by: Timo Sand <timo.sand@f-secure.com>

Deletes primary_language test as it mainly tests API functionality,…

c141a6e

… not provider Signed-off-by: Timo Sand <timo.sand@f-secure.com>

Add helper for temporarily disabling forking

871ae75

Signed-off-by: Timo Sand <timo.sand@f-secure.com>

Address linter issues

95d4412

Signed-off-by: Timo Sand <timo.sand@f-secure.com>

Add missing doc update

46b7fd9

Signed-off-by: Timo Sand <timo.sand@f-secure.com>

Ensure that Org setting modifying tests don't run in parallel

59e79ff

Signed-off-by: Timo Sand <timo.sand@f-secure.com>

Address copilot comment

4c1b31f

Signed-off-by: Timo Sand <timo.sand@f-secure.com>

Modernize repository Data Source tests

a993205

Signed-off-by: Timo Sand <timo.sand@f-secure.com>

Address possible edge-case if either allow_ settings value is not k…

058745f

…nown at diff time Signed-off-by: Timo Sand <timo.sand@f-secure.com>

Ensure all fields are documented

c443c38

Signed-off-by: Timo Sand <timo.sand@f-secure.com>

Remove reading and sending of has_downloads as it doesn't do anything

737ac4a

Signed-off-by: Timo Sand <timo.sand@f-secure.com>

Remove duplicate Description field

7675956

Signed-off-by: Timo Sand <timo.sand@f-secure.com>

deiga force-pushed the refactor-github-repository branch from 87b3f0f to 7675956 Compare August 22, 2026 11:28

rilical reviewed Aug 24, 2026

View reviewed changes

Navigation Menu

Uh oh!

[MAINT] Modernize `github_repository` resource - #3310

[MAINT] Modernize `github_repository` resource#3310
deiga wants to merge 39 commits into
integrations:mainfrom
F-Secure-web:refactor-github-repository

deiga commented Mar 28, 2026 •

edited

Loading

Uh oh!

github-actions Bot commented Mar 28, 2026

Uh oh!

This comment was marked as outdated.

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Uh oh!

rilical left a comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Uh oh!

Conversation

deiga commented Mar 28, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Before the change?

After the change?

Pull request checklist

Does this introduce a breaking change?

Uh oh!

github-actions Bot commented Mar 28, 2026

Uh oh!

This comment was marked as outdated.

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

rilical left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

deiga commented Mar 28, 2026 •

edited

Loading