maint: Updates go-github dep to v77 #2891

nickfloyd · 2025-11-13T17:19:26Z

Resolves: #2809, #2602
Relates to: #2898

This change set is large. This was an intentional decision to drive forward our need to update go-github given the current provider was 10 or more versions behind the latest. The hope is that the release will encapsulate all of the braking changes over the last 12 months. This helps to make us just deal with them once if we choose to move forward on the major version bump. The last two releases were packed with much needed changes - so users, if they choose, can migrate as time allows while using the updates from v6.7.x and v6.8.x.

Additionally, we'll most likely cherry pick out feature sets from this branch that are not actual fixes and the like - i.e. projects APIs have stopped working so we can look at projects v2 as a new feature.

Before the change?

go-github v67

After the change?

go-github v77

Checklist

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

…reduce change confusion

- Implements CRUD operations for GitHub organization network configurations - Supports configuration of network settings for hosted compute (Actions) - Validates name format (alphanumeric, '.', '-', '_') and length (1-100 chars) - Enforces compute_service enum ('none', 'actions') - Requires exactly one network_settings_id - Includes comprehensive test suite with create, update, and import tests - Depends on go-github v77 (merged from PR integrations#2891) Resolves network configuration management for GitHub Actions hosted runners and other hosted compute services at the organization level.

stevehipwell · 2025-11-14T18:07:35Z

@nickfloyd I've noticed that you've swapped out team ids for slugs to deal with the deprecated methods but that will break the provider for anyone using it at any serious scale. The fix here is to deprecate the team_id field and introduce a parallel team_slug field; the cost of using a single field for both is significant and I previously optimised it for ID as that's what the provider was using in the REST API.

See #2497.

stevehipwell · 2025-11-14T18:44:02Z

@nickfloyd now that the provider is under maintenance I wouldn't be against adding the team_slug fields. I've got a few other team changes that are waiting on this PR.

stevehipwell · 2025-11-18T18:01:04Z

@nickfloyd is this ready for a review?

nickfloyd · 2025-11-18T18:04:52Z

@nickfloyd is this ready for a review?

Yes it is ❤️ . I'll need to sync the branch with #2902 once/if you approve my changes there.

stevehipwell · 2025-11-19T17:36:46Z

@nickfloyd I'll review this shortly.

deiga

First light-weight pass, the project migration docs seem to be missing?

This diff makes me wonder if we should mark the files in vendor/ as generated files with .gitattributes to make these diffs slightly easier. Not part of this PR of course

deiga · 2025-11-19T19:52:53Z

github/resource_github_organization_ruleset_test.go

+		if len(expandedRules.FilePathRestriction.RestrictedFilePaths) != 3 {
+			t.Errorf("Expected 3 restricted file paths, got %d", len(expandedRules.FilePathRestriction.RestrictedFilePaths))
+		}


question: Would it make sense to use something like len(rulesMap["file_path_restriction"][0]["file_path_restriction"]) instead of hard-coding the number 3 here?

This is really following the current idioms in the provider. It appears that the pattern might've set up for readability and determinism, as well as simplicity of implementation. We can certainly look at changing these down the road to establish a pattern.

deiga · 2025-11-19T19:53:42Z

github/resource_github_organization_ruleset_test.go

+		if expandedRules.MaxFileSize.MaxFileSize != 100 {
+			t.Errorf("Expected max file size to be 100, got %d", expandedRules.MaxFileSize.MaxFileSize)
 		}
 	}
+	if expandedRules.MaxFilePathLength != nil {
+		ruleCount++
+		if expandedRules.MaxFilePathLength.MaxFilePathLength != 250 {
+			t.Errorf("Expected max file path length to be 250, got %d", expandedRules.MaxFilePathLength.MaxFilePathLength)
+		}
+	}
+	if expandedRules.FileExtensionRestriction != nil {
+		ruleCount++
+		if len(expandedRules.FileExtensionRestriction.RestrictedFileExtensions) != 4 {


question: Same for these conditionals. Would it make sense to refer the rulesMap values directly instead of hard-coding them?

My opinion above is why I would not favor changing these right now but if we deem that as important then I'd be up for considering it.

@nickfloyd it's worth noting that the duplication of the expected value in the test and the error message caused quite a lot of overhead in the patch alignment PR. I'm also not sure I agree that this can be classed as an idiom and would be tempted to follow the boy scout rule and fix it as part of the changes.

Absolutely. I can totally get behind that. My concern is that this PR is already huge - so I can scope the modifications to just this file and any others related to it - we should follow up with a cleaner approach across the entire provider.

Side note. Since we moved away from interface{} the logic to prop dig is kinda gnarly - perhaps there is a better way to do this:

filePathRule := rulesMap["file_path_restriction"].([]any)[0].(map[string]any) expectedFilePaths := len(filePathRule["restricted_file_paths"].([]any))

Side note. Since we moved away from interface{} the logic to prop dig is kinda gnarly - perhaps there is a better way to do this:

Do you mean the use of any over interface{}?

deiga · 2025-11-19T19:59:28Z

website/docs/r/project_card.html.markdown

@@ -9,6 +9,8 @@ description: |-

 !> **Warning:** This resource no longer works as the [Projects (classic) REST API](https://docs.github.com/en/rest/projects/projects?apiVersion=2022-11-28) has been [removed](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) and as such has been deprecated. It will be removed in a future release.

+~> **Migration:** Please use the [`github_project_item`](./project_item.html) resource for GitHub Projects V2 instead.


issue: This file seems to be missing?

I think this doc needs removing as the projects V2 resources are in a separate PR and there is no migration path.

Yeah this was a left over artifact from my conversion and then later sundering it into it's own PR. I'll remove it. Great catch!

deiga · 2025-11-19T20:26:10Z

github/resource_github_organization_ruleset.go

-	var ruleset *github.Ruleset
+	var ruleset *github.RepositoryRuleset
 	var err error

-	ruleset, _, err = client.Organizations.CreateOrganizationRuleset(ctx, owner, rulesetReq)
+	ruleset, _, err = client.Organizations.CreateRepositoryRuleset(ctx, org, *rulesetReq)


note: Boy, this choice of naming was poor from the SDK. I had to read the API and SDK contents to make sure it's still doing the right thing 🙃

Agreed. I got this one wrong about 3 times because of it. Other than making the changes in the SDK itself I think we want to be cautious with our APIs as a result - balancing pragmatism with DX.

Naming is hard so GitHub likes to reuse names with slight contextual modifiers. The new function name is clearer in the context of the GitHub API as the old name duplicated the service context (organization) into the function name and didn't distinguish between ruleset types (which in fairness wasn't a problem when it was originally named). FYI I work on the SDK.

deiga · 2025-11-19T20:31:20Z

github/resource_github_repository_ruleset.go

 	// Use UpdateRulesetNoBypassActor here instead of UpdateRuleset *if* bypass_actors has changed.
 	// UpdateRuleset uses `omitempty` on BypassActors, causing empty arrays to be omitted from the JSON.
 	// UpdateRulesetNoBypassActor always includes the field so that bypass actors can actually be removed.
 	// See: https://github.com/google/go-github/blob/b6248e6f6aec019e75ba2c8e189bfe89f36b7d01/github/repos_rules.go#L196


question: This comment doesn't seem to be correct anymore, since we don't use UpdateRulesetNoBypassActor now. Is it otherwise still relevant?

Great catch / point. This was a changeset merged in after the migration. I'll clean it up ❤️

deiga · 2025-11-19T20:35:39Z

github/data_source_github_organization_security_managers.go


 	allTeams := make([]any, 0)

+	//nolint:staticcheck // SA1019: ListSecurityManagerTeams is deprecated but still needed for legacy compatibility


question: Do we have a plan when to migrate this to use ListTeamsAssignedToOrgRole instead? It seems Jan 1st ListSecurityManagerTeams might stop working?

Yes. Well sort of, there is an issue. @stevehipwell rightfully called out the issues with migrating to the team_slug from team_ids. RE: #2497

stevehipwell

I've added some review comments.

stevehipwell · 2025-11-19T21:17:07Z

github/resource_github_repository_collaborators.go

 	client := meta.(*Owner).v3client
-	orgID := meta.(*Owner).id
 	owner := meta.(*Owner).name
+	orgId := meta.(*Owner).id


Suggested change

orgId := meta.(*Owner).id

orgID := meta.(*Owner).id

Why did you change this? In Go the idiomatic capitalization is <thing>ID.

stevehipwell · 2025-11-19T21:21:29Z

github/resource_github_repository_pull_request.go

 	}

-	errs := []string{fmt.Sprintf("could not update the Pull Request: %v", err)}
+	errors := []string{fmt.Sprintf("could not update the Pull Request: %v", err)}


Suggested change

errors := []string{fmt.Sprintf("could not update the Pull Request: %v", err)}

errs := []string{fmt.Sprintf("could not update the Pull Request: %v", err)}

Why did you change this? This would shadow the errors package in the stdlib and even if it's not currently being used in this file it's not idiomatic.

stevehipwell · 2025-11-19T21:24:08Z

github/resource_github_team_repository.go


 	client := meta.(*Owner).v3client
-	orgId := meta.(*Owner).id
+	teamSlug := d.Get("slug").(string)


I'm not sure where slug is defined? I suspect this may be left over from some previous changes?

stevehipwell · 2025-11-19T21:24:37Z

github/resource_github_team_repository.go

-	teamId, err := getTeamID(teamIdString, meta)
-	if err != nil {
-		return err
-	}


I think this might need putting back?

stevehipwell · 2025-11-19T21:24:48Z

github/resource_github_team_repository.go

 	}

-	repo, resp, repoErr := client.Teams.IsTeamRepoByID(ctx, orgId, teamId, orgName, repoName)
+	repo, resp, repoErr := client.Teams.IsTeamRepoBySlug(ctx, orgName, teamSlug, orgName, repoName)


I think this might need undoing?

stevehipwell · 2025-11-19T21:44:29Z

github/resource_github_organization_ruleset.go

-	ruleset, resp, err = client.Organizations.GetOrganizationRuleset(ctx, owner, rulesetID)
+	ruleset, resp, err = client.Organizations.GetRepositoryRuleset(ctx, org, rulesetID)
 	if err != nil {
 		ghErr := &github.ErrorResponse{}


This code pattern looks to be fundamentally flawed as we've got an error and are not handling it, I suspect we'd find it throughout the codebase. In this case we don't return the error and the ruleset is empty so we remove it from state which can result in issues like #2889.

stevehipwell · 2025-11-19T21:47:11Z

github/resource_github_organization_ruleset.go

+		return nil
+	}
+
+	if ruleset == nil {


This duplication looks like a typo?

Oof good catch.

stevehipwell · 2025-11-19T21:48:25Z

github/resource_github_repository_collaborators.go

 	for _, t := range want {
 		teamData := t.(map[string]any)
 		teamIDString := teamData["team_id"].(string)
+		teamSlug, err := getTeamSlug(teamIDString, meta)


I think this might be left over from some removed changes?

Yeah, great catch... it was missed when I was making changes after your comment.

stevehipwell · 2025-11-19T21:49:58Z

github/resource_github_repository_collaborators.go

 		permission := teamData["permission"].(string)
 		// team needs to be added
-		log.Printf("[DEBUG] Adding team %s with permission %s for repo: %s.", teamIDString, permission, repoName)
+		log.Printf("[DEBUG] Adding team %s with permission %s for repo: %s.", teamSlug, permission, repoName)


We shouldn't have the team slug due to the overhead of doing so, so this should be using the team id.

Looks like I missed one during the rollback.. thx for the heads up.

stevehipwell · 2025-11-19T21:50:21Z

github/resource_github_repository_ruleset.go

 		},

-		SchemaVersion: 1,
+		SchemaVersion: 2,


As org ruleset comment.

Updates go-github dep to v68

f9312e0

nickfloyd self-assigned this Nov 13, 2025

nickfloyd added the Type: Breaking change Used to note any change that requires a major version bump label Nov 13, 2025

nickfloyd added this to Terraform Provider Nov 13, 2025

nickfloyd added the Type: Maintenance Any dependency, housekeeping, and clean up Issue or PR label Nov 13, 2025

github-project-automation bot moved this to Backlog in Terraform Provider Nov 13, 2025

nickfloyd moved this from Backlog to In Progress in Terraform Provider Nov 13, 2025

nickfloyd added 11 commits November 13, 2025 11:23

Vendoring updates

d5c316c

Update to go-github v77

211cc10

vendor

aaf8089

add project item, deprecate project card

13f6e20

Add project item to the resource map

5c5babb

make org project read-only

6a6163a

Deprecate project column

8064292

API renames: edit to update

bb3b6ed

API renames: edit to update

808de22

Use new CreateRef API

3a82a12

Defer ruleset changes - they need to be done in a separate branch to …

06076f2

…reduce change confusion

nickfloyd mentioned this pull request Nov 13, 2025

[MAINT]: Update to go-github v68 #2809

Open

1 task

nickfloyd changed the title ~~Updates go-github dep to v68~~ Updates go-github dep to v77 Nov 13, 2025

austenstone mentioned this pull request Nov 14, 2025

feat: Add github_organization_network_configuration resource #2895

Draft

6 tasks

nickfloyd mentioned this pull request Nov 14, 2025

chore: Update golangci-lint to v2 #2864

Merged

5 tasks

nickfloyd added 5 commits November 14, 2025 09:33

Adds / Updates rulesets

b12b4ad

Renames Project V2 and removes legacy/classic projects concerns

24df569

Merge remote-tracking branch 'origin/main' into go-github-v68

1229e45

manual updates from merge

5045600

Linting fixes and updating APIs

fc9e86e

nickfloyd mentioned this pull request Nov 14, 2025

feat: Projects v2 project items & go-github v79 #2898

Open

9 tasks

nickfloyd force-pushed the go-github-v68 branch from 4a9558d to 3ac34e3 Compare November 14, 2025 18:35

nickfloyd added 3 commits November 14, 2025 13:33

adds nolint for depricated teams APIs

7df8bfc

adds ruleset migrations to signal underlying implemetnation has changed.

e87f8a9

Adds tests for migrations

10a6ee7

nickfloyd marked this pull request as ready for review November 14, 2025 20:37

nickfloyd requested a review from stevehipwell November 14, 2025 20:38

nickfloyd mentioned this pull request Nov 17, 2025

[BUG]: v6.8.2 terraform validate fails on the github provider #2903

Closed

1 task

eyalgal mentioned this pull request Nov 17, 2025

[MAINT]: Upgrade google/go-github to v70 #2602

Open

1 task

stevehipwell mentioned this pull request Nov 18, 2025

[BUG]: Resource github_repository_ruleset inconsistence issue #2889

Open

1 task

deiga mentioned this pull request Nov 18, 2025

feat : Support repository property for GitHub organization ruleset #2356

Open

4 tasks

Merge branch 'main' into go-github-v68

372b95f

nickfloyd added 2 commits November 18, 2025 13:59

Merge branch 'main' into go-github-v68

75a94a4

updates test to ignore ordinal eval

be8aaad

nickfloyd moved this from In Progress to In Review in Terraform Provider Nov 18, 2025

nickfloyd mentioned this pull request Nov 19, 2025

[BATCH]: Add Project V2 resources #2916

Open

16 tasks

nickfloyd changed the title ~~Updates go-github dep to v77~~ maint: Updates go-github dep to v77 Nov 19, 2025

nickfloyd added this to the v7.0.0 Release milestone Nov 19, 2025

deiga reviewed Nov 19, 2025

View reviewed changes

stevehipwell mentioned this pull request Nov 19, 2025

feat: Refactored acceptance test automation #2476

Draft

33 tasks

stevehipwell requested changes Nov 19, 2025

View reviewed changes

nickfloyd added 5 commits November 19, 2025 15:55

removes docs for deprecated resources

2ea09b5

remove out of date comment

7f5a0fc

removes dup log

bc76119

removes static values on test evaluatations.

b52b7e8

removes superfluous migrations for rulesets

67f2f4b

		@@ -9,6 +9,8 @@ description: \|-

		!> Warning: This resource no longer works as the [Projects (classic) REST API](https://docs.github.com/en/rest/projects/projects?apiVersion=2022-11-28) has been [removed](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) and as such has been deprecated. It will be removed in a future release.

		~> Migration: Please use the [`github_project_item`](./project_item.html) resource for GitHub Projects V2 instead.


		allTeams := make([]any, 0)

		//nolint:staticcheck // SA1019: ListSecurityManagerTeams is deprecated but still needed for legacy compatibility

	errors := []string{fmt.Sprintf("could not update the Pull Request: %v", err)}
	errs := []string{fmt.Sprintf("could not update the Pull Request: %v", err)}

maint: Updates go-github dep to v77 #2891

Are you sure you want to change the base?

maint: Updates go-github dep to v77 #2891

Uh oh!

Conversation

nickfloyd commented Nov 13, 2025 • edited by eyalgal Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Before the change?

After the change?

Checklist

Pull request checklist

Does this introduce a breaking change?

Uh oh!

stevehipwell commented Nov 14, 2025

Uh oh!

stevehipwell commented Nov 14, 2025

Uh oh!

stevehipwell commented Nov 18, 2025

Uh oh!

nickfloyd commented Nov 18, 2025

Uh oh!

stevehipwell commented Nov 19, 2025

Uh oh!

deiga left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

nickfloyd Nov 19, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

stevehipwell left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

nickfloyd commented Nov 13, 2025 •

edited by eyalgal

Loading

nickfloyd Nov 19, 2025 •

edited

Loading