[BUG] Ensure autolink reference doesn't error when repo is renamed by deiga · Pull Request #3271 · integrations/terraform-provider-github

deiga · 2026-03-12T20:08:18Z

Resolves #3470

Before the change?

Renaming a repository caused an existing github_repository_autolink_reference to be re-created and throw an error

After the change?

Renaming a repository does not cause an error in github_repository_autolink_reference

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-12T20:08:30Z

👋 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! 🚀

stevehipwell

Do we need a migration to add the repository ID and then rely on it or we just supporting it as a best effort?

Copilot

Pull request overview

These provider review instructions are being used.

This PR fixes #3470 for github_repository_autolink_reference so that renaming a repository no longer forces the autolink reference to be destroyed and recreated (which previously errored). It adopts the provider's rename-safe convention: drop ForceNew from repository, add a computed repository_id, and wire up CustomizeDiff: diffRepository so replacement is only forced when the underlying repository ID actually changes. The CRUD handlers are also modernized to the *Context variants, and a state upgrader is added to backfill repository_id.

Changes:

Convert CRUD to context-aware handlers, add a no-op Update, extract the importer, and switch logging to tflog.
Add repository_id (computed), remove ForceNew from repository, and add CustomizeDiff: diffRepository; add a state upgrader + migration to populate repository_id.
Update acceptance tests to statecheck/plancheck (incl. a rename scenario), add a migration unit test, and refresh docs/example.

Reviewed changes

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

Show a summary per file

File	Description
github/resource_github_repository_autolink_reference.go	Rename-safe schema (`repository_id`, no `ForceNew`, `diffRepository`), context CRUD, no-op `Update`; state upgrader registered with a version mismatch (blocking).
github/resource_github_repository_autolink_reference_migration.go	New V0 schema + state upgrade func that fetches and stores `repository_id`.
github/resource_github_repository_autolink_reference_migration_test.go	Unit test invoking the state upgrade function directly against a mocked API.
github/resource_github_repository_autolink_reference_test.go	Migrates checks to `statecheck`, adds a repository-rename in-place test.
templates/resources/repository_autolink_reference.md.tmpl	Docs template: updated `repository` description, adds `repository_id`.
docs/resources/repository_autolink_reference.md	Generated docs mirror the template/schema updates and `visibility` example.
examples/resources/repository_autolink_reference/example_1.tf	Example switched from deprecated `private` to `visibility`.

Blocking finding: the added StateUpgrader uses Version: 0 while the resource already ships at SchemaVersion: 1, so it will never execute for existing state (which is already stamped v1). The version must be bumped to 2 with the upgrader registered at Version: 1 to actually backfill repository_id.

stevehipwell

Just a quick review.

stevehipwell · 2026-07-10T10:21:01Z

+	parts := strings.Split(d.Id(), "/")
+	if len(parts) != 2 {
+		return nil, fmt.Errorf("invalid ID specified: supplied ID must be written as <repository>/<autolink_reference_id>")
+	}


I think the ID should be migrated as part of the schema migration so it can use the ID functions.

Since this is "just" the import ID, it doesn't need a migration, right?

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

deiga added this to the v6.12.0 Release milestone Mar 15, 2026

deiga requested a review from stevehipwell March 15, 2026 16:51

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

deiga force-pushed the ensure-autolinks-are-aware-of-repo-rename branch from ad1fdb7 to 00ea1c8 Compare April 18, 2026 18:34

deiga added the Type: Bug Something isn't working as documented label Apr 18, 2026

deiga force-pushed the ensure-autolinks-are-aware-of-repo-rename branch from 00ea1c8 to 458f672 Compare May 11, 2026 02:13

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

stevehipwell reviewed May 15, 2026

View reviewed changes

Comment thread github/resource_github_repository_autolink_reference.go

deiga removed this from the v6.13.0 milestone Jun 3, 2026

deiga force-pushed the ensure-autolinks-are-aware-of-repo-rename branch from 458f672 to 852d646 Compare June 6, 2026 05:29

deiga force-pushed the ensure-autolinks-are-aware-of-repo-rename branch from 852d646 to 50a9aa7 Compare July 9, 2026 18:29

deiga marked this pull request as ready for review July 9, 2026 18:29

deiga requested a review from Copilot July 9, 2026 18:30

Copilot started reviewing on behalf of deiga July 9, 2026 18:30 View session

Copilot AI reviewed Jul 9, 2026

View reviewed changes

Comment thread github/resource_github_repository_autolink_reference.go Outdated

deiga requested a review from stevehipwell July 9, 2026 18:42

deiga force-pushed the ensure-autolinks-are-aware-of-repo-rename branch from cf7ee3b to 4b95c1a Compare July 10, 2026 09:01

stevehipwell reviewed Jul 10, 2026

View reviewed changes

deiga force-pushed the ensure-autolinks-are-aware-of-repo-rename branch from 4b95c1a to aaa15da Compare July 14, 2026 19:55

stevehipwell requested changes Jul 15, 2026

View reviewed changes

deiga force-pushed the ensure-autolinks-are-aware-of-repo-rename branch from aaa15da to ba732c3 Compare July 22, 2026 19:21

deiga force-pushed the ensure-autolinks-are-aware-of-repo-rename branch from ba732c3 to a66eaa4 Compare August 3, 2026 18:24

deiga requested a review from stevehipwell August 3, 2026 18:24

deiga added 5 commits August 22, 2026 14:13

Update to use Context-aware functions

22ec6f3

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

Enable repository rename

0bb789d

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

Refactor to use ConfigStateChecks instead of Check in tests

316bbe6

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

Update docs

b3a5468

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

Move import function to named function

021c796

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

deiga added 6 commits August 22, 2026 14:13

Add schema migrations

1c2d3a5

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

Fix changed reference

a7268c5

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

Ensure migrations actually run for users

27527f8

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

Update resources file

034e733

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

Fix migration file

7244078

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

Address logging related comments

a65ffaa

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

deiga added the vNext label Aug 22, 2026

deiga added 8 commits August 22, 2026 14:13

Modernize error handling

f6aa6a0

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

Update import to set all necessary fields

1eea6db

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

Update tests to use modern test setup

9770b5a

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

Update docs to use generation

c54e2f3

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

Address review comments

24d2856

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

Address review comments on migration

8432c9e

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

Add helper for migrating resource ID to idSeparator

ecd23b8

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

Migrate import ID separator

f1c9742

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

deiga force-pushed the ensure-autolinks-are-aware-of-repo-rename branch from a66eaa4 to f1c9742 Compare August 22, 2026 11:15

Uh oh!

Conversation

deiga commented Mar 12, 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 12, 2026

Uh oh!

stevehipwell left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

stevehipwell left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

stevehipwell Jul 10, 2026

Choose a reason for hiding this comment

Uh oh!

deiga Aug 3, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

deiga commented Mar 12, 2026 •

edited

Loading