[MAINT] Convert legacy Schema Migrations to use StateUpgraders #3065

deiga · 2026-01-07T21:00:14Z

Supersedes #3018

Before the change?

Schema Migrations used MigrateState which is from 0.11 of the SDK
Converted resources:
- github_actions_organization_secret
- github_actions_secret
- github_repository_webhook
- github_repository

After the change?

Schema Migrations use StateUpgraders which is the default since 0.12 of the SDK

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-01-07T21:00:23Z

👋 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

Could we move the migration code into the resource files instead of having it in separate files which makes it significantly harder to reason about?

nickfloyd · 2026-01-08T17:45:43Z

Could we move the migration code into the resource files instead of having it in separate files which makes it significantly harder to reason about?

We can definitely do that - I'd recommend that we follow up with changing the existing ones as well so that we have a consistent pattern.

stevehipwell · 2026-01-08T17:54:12Z

@nickfloyd I think this PR is modifying all of the existing ones, so I was meaning for all migrations to be located next to the relevant schemas.

nickfloyd · 2026-01-08T17:57:00Z

@stevehipwell That makes so much more sense... thank you for the clarity.

deiga · 2026-01-08T20:21:45Z

@nickfloyd @stevehipwell I'm honestly not sure about merging the migration files with the resource files

Some of these migration files are very long and since they contain Schemas at specific points in time it could make it confusing to have multiple schema in the same file. Or would we keep the schemas still in separate files and only move the state upgrade functions to the resource files?

stevehipwell · 2026-01-08T20:24:56Z

What about adding schema files with the same name as the primary files and then adding a schema suffix so they're at least located next to each other? For example github_resource_foo.go & github_resource_foo_schema.go

nickfloyd · 2026-01-08T20:43:47Z

@stevehipwell I'm wondering if this would be a good move for 7.x. I really like the idea of a related grouping so for instance our protocol would be:

github_[resource]_[function].go

So, given something like: branch_protection, like you were sketching out, you'd have:

github_branch_protection_migrate.go
github_branch_protection_resource.go
github_branch_protection_resource_test.go
github_branch_protection_data_source.go
github_branch_protection_data_source_test.go

Is that what you were thinking? If so I can write up an issue for us to rework all of that.

deiga · 2026-01-08T20:45:14Z

@stevehipwell Something like this? 710d9b8 (#3065)

stevehipwell · 2026-01-08T22:24:56Z

@deiga do you mean the code or file paths?

@nickfloyd for v7 I'd suggest aligning to a more idiomatic approach like below. But for now I'd really like to see the migration code moved as it's all being modified.

internal/provider/data_repository.go
internal/provider/data_repository_schema.go
internal/provider/data_repository_test.go
internal/provider/repository.go
internal/provider/repository_schema.go
internal/provider/repository_test.go

deiga · 2026-01-08T22:54:14Z

@stevehipwell Both? Just wanted to double check if this close enough to what you had in mind, before I do the same change for every migration file

stevehipwell · 2026-01-09T10:10:50Z

@stevehipwell Both? Just wanted to double check if this close enough to what you had in mind, before I do the same change for every migration file

I was on my phone so it was hard to figure out what had changed.

OK, how about github/resource_github_actions_secret_migration.go (& github/resource_github_actions_secret_migration_test.go) with the migration functions and the schemas in the one file? I think this will meet my desire for keeping the code together without adding additional complexity to the main files. Also after thinking it through carefully I realized that once the migration has happened the code is effectively meaningless so should be kept out of the way for general readability.

stevehipwell

The code changes look great, I've just added a comment suggesting a change to the way that the migration function tests are structured.

github/resource_github_actions_organization_secret_migration_test.go

stevehipwell

LGTM

stevehipwell · 2026-01-15T20:23:31Z

@deiga could you please rebase this PR?

…ers` for schema migrations Signed-off-by: Timo Sand <timo.sand@f-secure.com>

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

…tionWebhook` schema migrations to use StateUpgraders Signed-off-by: Timo Sand <timo.sand@f-secure.com>

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

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

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

Rename migrate_github_actions_organization_secret*.go to resource_github_actions_organization_secret_migration*.go for consistent naming with resource files.

Rename migrate_github_branch_protection.go to resource_github_branch_protection_migration.go for consistent naming with resource files.

Rename migrate_github_organization_webhook*.go to resource_github_organization_webhook_migration*.go for consistent naming with resource files.

Rename migrate_github_repository*.go to resource_github_repository_migration*.go for consistent naming with resource files.

Rename migrate_github_repository_webhook*.go to resource_github_repository_webhook_migration*.go for consistent naming with resource files.

Migrate resource_github_actions_secret.go from legacy CRUD functions to Context-aware functions (CreateContext, ReadContext, DeleteContext). - Add diag import - Update function signatures to accept context.Context - Return diag.Diagnostics instead of error - Use StateContext for importer Ref: integrations#2996

Migrate resource_github_actions_organization_secret.go from legacy CRUD to context-aware CRUD functions (CreateContext, ReadContext, DeleteContext) per Terraform Plugin SDK v2 best practices. Ref: integrations#2996

Migrate resource_github_organization_webhook.go from legacy CRUD to context-aware CRUD functions (CreateContext, ReadContext, UpdateContext, DeleteContext) per Terraform Plugin SDK v2 best practices. Ref: integrations#2996

Migrate resource_github_repository_webhook.go from legacy CRUD to context-aware CRUD functions (CreateContext, ReadContext, UpdateContext, DeleteContext) per Terraform Plugin SDK v2 best practices. Ref: integrations#2996

deiga mentioned this pull request Jan 7, 2026

[MAINT] Migrate to use terraform-plugin-testing instead of the SDK testing package #3066

Open

5 tasks

stevehipwell requested changes Jan 8, 2026

View reviewed changes

stevehipwell added this to the v6.10.0 Release milestone Jan 8, 2026

stevehipwell added the Type: Maintenance Any dependency, housekeeping, and clean up Issue or PR label Jan 8, 2026

deiga force-pushed the upgrade-state-migrations branch from 6fc64f6 to 710d9b8 Compare January 8, 2026 20:44

deiga requested a review from stevehipwell January 10, 2026 21:02

deiga force-pushed the upgrade-state-migrations branch 2 times, most recently from 04ae654 to c4fd2a4 Compare January 13, 2026 20:05

stevehipwell requested changes Jan 15, 2026

View reviewed changes

github/resource_github_actions_organization_secret_migration_test.go Show resolved Hide resolved

stevehipwell approved these changes Jan 15, 2026

View reviewed changes

deiga added 8 commits January 15, 2026 22:23

Convert resourceGithubActionsOrganizationSecret to use `StateUpgrad…

9652810

…ers` for schema migrations Signed-off-by: Timo Sand <timo.sand@f-secure.com>

Convert resourceGithubActionsSecret to use StateUpgraders for sch…

19e5daf

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

Convert resourceGithubRepositoryWebhook and `resourceGithubOrganiza…

1727e17

…tionWebhook` schema migrations to use StateUpgraders Signed-off-by: Timo Sand <timo.sand@f-secure.com>

Convert resourceGithubRepository schema migration to use StateUpgra…

17002c5

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

Restructure github_actions_secret state migration files

f67519f

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

Rename to new naming scheme <resource>_migration.go

b0ad87e

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

Mmove migration code to _migration.go file and exxtract tests to _mig…

32395ce

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

refactor(github): rename actions organization secret migration files

653fcde

Rename migrate_github_actions_organization_secret*.go to resource_github_actions_organization_secret_migration*.go for consistent naming with resource files.

deiga added 8 commits January 15, 2026 22:23

refactor(github): rename branch protection migration file

cd67a89

Rename migrate_github_branch_protection.go to resource_github_branch_protection_migration.go for consistent naming with resource files.

refactor(github): rename organization webhook migration files

a314f3c

Rename migrate_github_organization_webhook*.go to resource_github_organization_webhook_migration*.go for consistent naming with resource files.

refactor(github): rename repository migration files

6e7061a

Rename migrate_github_repository*.go to resource_github_repository_migration*.go for consistent naming with resource files.

refactor(github): rename repository webhook migration files

cb29e9a

Rename migrate_github_repository_webhook*.go to resource_github_repository_webhook_migration*.go for consistent naming with resource files.

refactor(actions-org-secret): migrate to context-aware CRUD functions

055b0ff

Migrate resource_github_actions_organization_secret.go from legacy CRUD to context-aware CRUD functions (CreateContext, ReadContext, DeleteContext) per Terraform Plugin SDK v2 best practices. Ref: integrations#2996

refactor(org-webhook): migrate to context-aware CRUD functions

21780c8

Migrate resource_github_organization_webhook.go from legacy CRUD to context-aware CRUD functions (CreateContext, ReadContext, UpdateContext, DeleteContext) per Terraform Plugin SDK v2 best practices. Ref: integrations#2996

refactor(repo-webhook): migrate to context-aware CRUD functions

8b6a21f

Migrate resource_github_repository_webhook.go from legacy CRUD to context-aware CRUD functions (CreateContext, ReadContext, UpdateContext, DeleteContext) per Terraform Plugin SDK v2 best practices. Ref: integrations#2996

deiga force-pushed the upgrade-state-migrations branch from c4fd2a4 to 8b6a21f Compare January 15, 2026 20:24

nickfloyd approved these changes Jan 16, 2026

View reviewed changes

stevehipwell merged commit 1dfeffe into integrations:main Jan 16, 2026
8 checks passed

[MAINT] Convert legacy Schema Migrations to use StateUpgraders #3065

[MAINT] Convert legacy Schema Migrations to use StateUpgraders #3065

Uh oh!

Conversation

deiga commented Jan 7, 2026

Before the change?

After the change?

Pull request checklist

Does this introduce a breaking change?

Uh oh!

github-actions bot commented Jan 7, 2026

Uh oh!

stevehipwell left a comment

Choose a reason for hiding this comment

Uh oh!

nickfloyd commented Jan 8, 2026

Uh oh!

stevehipwell commented Jan 8, 2026

Uh oh!

nickfloyd commented Jan 8, 2026

Uh oh!

deiga commented Jan 8, 2026

Uh oh!

stevehipwell commented Jan 8, 2026

Uh oh!

nickfloyd commented Jan 8, 2026

Uh oh!

deiga commented Jan 8, 2026

Uh oh!

stevehipwell commented Jan 8, 2026

Uh oh!

deiga commented Jan 8, 2026

Uh oh!

stevehipwell commented Jan 9, 2026

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!

stevehipwell commented Jan 15, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants