[MAINT] Improve Import behaviour of `github_default_branch` by deiga · Pull Request #3216 · integrations/terraform-provider-github

deiga · 2026-02-21T20:01:37Z

Resolves #2613

Before the change?

Resource didn't use Context-aware functions
Resource didn't use tflog for logging
Missing tests for Update and Import functionality

After the change?

Changes to use Context-aware functions
Changes to use tflog for logging
Adds support for repository renaming, by add repository_id field and removing ForceNew from repository

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-02-21T20:01: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 updates the github_branch_default resource to improve import and rename behavior, modernize the resource implementation to SDKv2 context-aware CRUD, and align logging and tests with current provider patterns.

Changes:

Refactors github_branch_default to use CreateContext/ReadContext/UpdateContext/DeleteContext, returns diag.Diagnostics, and uses tflog.
Adds rename-safe repository handling via repository_id + CustomizeDiff: diffRepository, and updates docs/templates to document the new exported attribute.
Expands acceptance coverage to include update and import scenarios using statecheck/plancheck.

Reviewed changes

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

File	Description
`github/resource_github_branch_default.go`	Refactors resource to context-aware CRUD + `tflog`, adds `repository_id`, custom import handler, and rename-safe diffing.
`github/resource_github_branch_default_test.go`	Adds/updates acceptance tests using modern `statecheck`/`plancheck` patterns for create/update/import coverage.
`docs/resources/branch_default.md`	Documents exported `repository_id` attribute and clarifies import ID format.
`templates/resources/branch_default.md.tmpl`	Mirrors docs updates for generated documentation (`repository_id` + import wording).

stevehipwell

Just a quick pre-pass to look at the coding patterns for a re-work. The multi line tflog statements make reviewing harder; as does the type checking but I think we need to keep that (other than for meta in the resource functions).

stevehipwell

It looks like the code for the repository_id addition is missing (e.g. migration, import, update ID modification). I'd also suggest that the docs be updated to the new pattern as part of this change given the attributes are being modified.

deiga · 2026-06-05T19:24:25Z

It looks like the code for the repository_id addition is missing (e.g. migration, import, update ID modification). I'd also suggest that the docs be updated to the new pattern as part of this change given the attributes are being modified.

🤦 Doh!
Good catch, adding that now

Copilot

Pull request overview

Copilot reviewed 10 out of 10 changed files in this pull request and generated 1 comment.

stevehipwell

If you wait for #3476 to be merged you can reuse the repo ID migration logic.

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

Removing `etag` after rename made it visible that the GH API is eventually consistent when a branch is being renamed. Signed-off-by: Timo Sand <timo.sand@f-secure.com>

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

stevehipwell

LGTM

github-actions Bot added the Type: Bug Something isn't working as documented label Feb 21, 2026

deiga added this to the v6.12.0 Release milestone Feb 22, 2026

deiga force-pushed the fix-default-branch-import branch from 0e63837 to a31fc9f Compare March 8, 2026 21:14

deiga requested a review from stevehipwell March 8, 2026 21:15

deiga modified the milestones: v6.12.0 Release, v6.13.0 Release Apr 14, 2026

deiga force-pushed the fix-default-branch-import branch from a31fc9f to cd4dd3d Compare May 11, 2026 02:08

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 fix-default-branch-import branch from b44b2a4 to 687ec04 Compare June 3, 2026 17:16

deiga marked this pull request as ready for review June 3, 2026 17:16

deiga force-pushed the fix-default-branch-import branch from b417ac4 to 055d00c Compare June 3, 2026 18:25

deiga requested a review from Copilot June 3, 2026 18:26

Copilot started reviewing on behalf of deiga June 3, 2026 18:26 View session

Copilot AI reviewed Jun 3, 2026

View reviewed changes

deiga requested a review from stevehipwell June 3, 2026 19:50

stevehipwell requested changes Jun 4, 2026

View reviewed changes

Comment thread github/resource_github_branch_default.go Outdated

Comment thread github/resource_github_branch_default.go Outdated

Comment thread github/resource_github_branch_default.go Outdated

deiga force-pushed the fix-default-branch-import branch from 9d51b80 to 85640c2 Compare June 4, 2026 11:18

stevehipwell requested changes Jun 5, 2026

View reviewed changes

Comment thread github/resource_github_branch_default.go Outdated

Comment thread github/resource_github_branch_default.go Outdated

deiga force-pushed the fix-default-branch-import branch from efdac3c to 4137ac7 Compare June 5, 2026 20:06

deiga requested review from Copilot and stevehipwell June 5, 2026 20:07

Copilot started reviewing on behalf of deiga June 5, 2026 20:08 View session

Copilot AI reviewed Jun 5, 2026

View reviewed changes

Comment thread github/resource_github_branch_default.go

stevehipwell requested changes Jun 8, 2026

View reviewed changes

deiga requested a review from stevehipwell June 12, 2026 06:36

stevehipwell requested changes Jun 12, 2026

View reviewed changes

Comment thread github/resource_github_branch_default.go

deiga force-pushed the fix-default-branch-import branch from 6b9e94a to 0220d16 Compare June 21, 2026 20:27

deiga added 22 commits June 24, 2026 10:18

Rename branch only if it's different from current default branch

f65a2aa

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

Fix documentation error

0271a3c

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

Add acc tests to verify Destroy behaviour

072be3b

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

Address review comments

55f8b93

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

Use errors.AsType pattern

637360d

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

Address review comments

cd1a46a

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

Add state migration and tests

bd9c20d

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

Update docs template to be mostly generated

7dad19f

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

Ensure that ID gets updated if reponame changes

30c96f0

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

Remove typeasserts from schema fields

d022c0c

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

Address review comments

9ff4124

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

Address rename

d3d70ad

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

Adopt migrateRepositoryWithID pattern

b910685

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

Address review comments

d873769

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

Add wait for branch rename

4aa0e2c

Removing `etag` after rename made it visible that the GH API is eventually consistent when a branch is being renamed. Signed-off-by: Timo Sand <timo.sand@f-secure.com>

Address review comments

d90cd47

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

Simplify migration logic

bdcdf8e

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

Address copilot comments

47d397d

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

Make waiting optional

7654612

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

Add unit test to verify that waiting is skipped if not configured

91c4e0e

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

Update docs

bfaeb59

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

Fix linter

826998a

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

deiga dismissed stale reviews from stevehipwell and robert-crandall via 826998a June 24, 2026 07:20

deiga force-pushed the fix-default-branch-import branch from c9eb706 to 826998a Compare June 24, 2026 07:20

deiga requested review from robert-crandall and stevehipwell June 24, 2026 07:53

stevehipwell approved these changes Jun 24, 2026

View reviewed changes

stevehipwell merged commit 1eaeaeb into integrations:main Jun 24, 2026
13 of 19 checks passed

deiga deleted the fix-default-branch-import branch June 24, 2026 09:17

Conversation

deiga commented Feb 21, 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 Feb 21, 2026

Uh oh!

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!

Uh oh!

Uh oh!

stevehipwell left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

stevehipwell left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

deiga commented Jun 5, 2026

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!

Uh oh!

stevehipwell left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

stevehipwell left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

deiga commented Feb 21, 2026 •

edited

Loading