Add ID migration in the same bunch

Signed-off-by: Timo Sand <[email protected]>

Author: deiga

github/resource_github_repository_file.go

@@ -234,7 +234,9 @@ func resourceGithubRepositoryFileCreate(ctx context.Context, d *schema.ResourceD
 		return diag.FromErr(err)
 	}
 
-	d.SetId(fmt.Sprintf("%s/%s", repo, file))
+	branch := d.Get("branch").(string)
+
+	d.SetId(fmt.Sprintf("%s/%s:%s", repo, file, branch))
 	if err = d.Set("commit_sha", create.GetSHA()); err != nil {
 		return diag.FromErr(err)
 	}
@@ -484,7 +486,9 @@ func resourceGithubRepositoryFileImport(ctx context.Context, d *schema.ResourceD
 		return nil, fmt.Errorf("file %s is not a file in repository %s/%s or repository is not readable", file, owner, repo)
 	}
 
-	d.SetId(fmt.Sprintf("%s/%s", repo, file))
+	branch := d.Get("branch").(string)
+
+	d.SetId(fmt.Sprintf("%s/%s:%s", repo, file, branch))
 	if err = d.Set("overwrite_on_create", false); err != nil {
 		return nil, err
 	}

github/resource_github_repository_file_migration.go

@@ -108,6 +108,8 @@ func resourceGithubRepositoryFileStateUpgradeV0(ctx context.Context, rawState ma
 		rawState["branch"] = repo.GetDefaultBranch()
 	}
 
+	rawState["id"] = fmt.Sprintf("%s/%s:%s", rawState["repository"], rawState["file"], rawState["branch"])
+
 	tflog.Debug(ctx, "GitHub Repository File State after migration", map[string]any{
 		"rawState": rawState,
 	})

github/resource_github_repository_file_migration_test.go

@@ -2,8 +2,9 @@ package github
 
 import (
 	"context"
-	"reflect"
 	"testing"
+
+	"github.com/google/go-cmp/cmp"
 )
 
 func Test_resourceGithubRepositoryFileStateUpgradeV0(t *testing.T) {
@@ -28,7 +29,7 @@ func Test_resourceGithubRepositoryFileStateUpgradeV0(t *testing.T) {
 				"overwrite_on_create": false,
 			},
 			want: map[string]any{
-				"id":                  "test-repo/path/to/file.txt",
+				"id":                  "test-repo/path/to/file.txt:main",
 				"repository":          "test-repo",
 				"file":                "path/to/file.txt",
 				"content":             "file content",
@@ -49,7 +50,7 @@ func Test_resourceGithubRepositoryFileStateUpgradeV0(t *testing.T) {
 				"branch":     "develop",
 			},
 			want: map[string]any{
-				"id":         "test-repo/README.md",
+				"id":         "test-repo/README.md:develop",
 				"repository": "test-repo",
 				"file":       "README.md",
 				"content":    "# README",
@@ -67,7 +68,7 @@ func Test_resourceGithubRepositoryFileStateUpgradeV0(t *testing.T) {
 		// 				"content":    "file content",
 		// 			},
 		// 			want: map[string]any{
-		// 				"id":         "test-repo/path/to/file.txt",
+		// 				"id":         "test-repo/path/to/file.txt:main",
 		// 				"repository": "test-repo",
 		// 				"file":       "path/to/file.txt",
 		// 				"content":    "file content",
@@ -86,7 +87,7 @@ func Test_resourceGithubRepositoryFileStateUpgradeV0(t *testing.T) {
 		// 				"branch":     "",
 		// 			},
 		// 			want: map[string]any{
-		// 				"id":         "test-repo/path/to/file.txt",
+		// 				"id":         "test-repo/path/to/file.txt:main",
 		// 				"repository": "test-repo",
 		// 				"file":       "path/to/file.txt",
 		// 				"content":    "file content",
@@ -103,8 +104,8 @@ func Test_resourceGithubRepositoryFileStateUpgradeV0(t *testing.T) {
 				t.Fatalf("unexpected error state: got error %v, shouldError %v", err, d.shouldError)
 			}
 
-			if !d.shouldError && !reflect.DeepEqual(got, d.want) {
-				t.Fatalf("got %+v, want %+v", got, d.want)
+			if diff := cmp.Diff(got, d.want); diff != "" && !d.shouldError {
+				t.Fatalf("got %+v, want %+v, diff %s", got, d.want, diff)
 			}
 		})
 	}

go.mod

@@ -4,6 +4,7 @@ go 1.24.4
 
 require (
 	github.com/go-jose/go-jose/v3 v3.0.4
+	github.com/google/go-cmp v0.7.0
 	github.com/google/go-github/v82 v82.0.0
 	github.com/google/uuid v1.6.0
 	github.com/hashicorp/go-cty v1.5.0
@@ -21,7 +22,6 @@ require (
 	github.com/cloudflare/circl v1.6.1 // indirect
 	github.com/fatih/color v1.18.0 // indirect
 	github.com/golang/protobuf v1.5.4 // indirect
-	github.com/google/go-cmp v0.7.0 // indirect
 	github.com/google/go-querystring v1.2.0 // indirect
 	github.com/hashicorp/errwrap v1.0.0 // indirect
 	github.com/hashicorp/go-checkpoint v0.5.0 // indirect