refactor: migrate resource_github_issue_label to context-aware CRUD a… by slymanmrcan · Pull Request #3342 · integrations/terraform-provider-github

slymanmrcan · 2026-04-17T10:51:57Z

Addresses parts of #3070
Addresses parts of #2996

Before the change?

resource_github_issue_label uses legacy Create/Read/Update/Delete
schema functions and log.Printf for logging.

After the change?

Migrated to CreateContext/ReadContext/UpdateContext/DeleteContext
Function signatures updated to (ctx context.Context, d *schema.ResourceData, meta any) diag.Diagnostics
Replaced log.Printf with tflog.Info for structured logging
Removed manual context.Background() calls
Wrapped error returns with diag.FromErr()

Pull request checklist

Schema migrations have been created if needed — N/A, no schema change
Tests for the changes have been added — N/A, no behavior change
Docs have been reviewed and added / updated if needed — N/A

Does this introduce a breaking change?

No

github-actions · 2026-04-17T10:52:08Z

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

deiga · 2026-04-18T15:55:52Z

Please remove the resolves comment, since it adresses the issue only partly. And "resolves" will close the issue

deiga

LGTM!

Thanks for the contribution!

slymanmrcan · 2026-04-18T16:25:20Z

I just removed it from the description

deiga · 2026-06-03T18:35:42Z

Would you be available to rebase this (possibly multiple times) during the next week? We're going to release 6.13.0 and will try to land some of these open PRs

Copilot

Pull request overview

This PR refactors resource_github_issue_label to use Terraform Plugin SDK v2 context-aware CRUD function signatures and structured logging via tflog, aligning the resource with ongoing provider-wide migrations tracked in #2996 and #3070.

Changes:

Migrated the resource from legacy Create/Read/Update/Delete to CreateContext/ReadContext/UpdateContext/DeleteContext.
Updated CRUD implementations to return diag.Diagnostics and wrap errors with diag.FromErr.
Replaced log.Printf usage with tflog.Info structured logging and removed context.Background() usage.

slymanmrcan · 2026-06-03T18:54:22Z

Yes, I can rebase it during the next week as needed.

I’ll rebase now and address the Copilot review comments as well.

deiga

@stevehipwell even though there are other parts here that could be refactored, I would suggest we do the minimum here to get this merged.

stevehipwell

For me the bare minimum here would be to separate create & update and remove the call to read from them.

slymanmrcan · 2026-06-11T10:58:03Z

Thanks, I separated the create and update handlers and removed the explicit read call from both paths while keeping the existing idempotent create behavior for default GitHub labels.

stevehipwell

@slymanmrcan this is looking good. There are still a couple of outstanding comments to address and it looks like you haven't run the strict linting for new code?

slymanmrcan · 2026-06-15T23:53:43Z

Thanks, my mistake. I missed the strict new-code lint locally.
I’ve run it now and addressed the findings in the latest push.

stevehipwell

Thanks for making the changes, I've added some feedback so you can follow the idiomatic patterns.

stevehipwell · 2026-06-18T08:16:01Z

Thanks @slymanmrcan, this looks good. Could you please rebase and let us know if you've run the acceptance tests for the resource locally?

stevehipwell

LGTM

robert-crandall

Thanks for taking this on - moving to context-aware CRUD and tflog is a nice cleanup, and I appreciate the careful function split. Both questions I left feel like behavior changes worth a second look. Happy to help think through it!

robert-crandall · 2026-06-18T23:30:01Z

-		orgName, repoName, originalName)
-	if err != nil && resp.StatusCode != http.StatusNotFound {
-		return err
+	githubLabel, resp, err := client.Issues.CreateLabel(ctx, orgName, repoName, label)


Quick question on intent: the old combined function did a GetLabel first and called EditLabel if the label already existed (the removed comment explained it - new repos ship default labels, and a name clash returns 422). This version calls CreateLabel directly, so a pre-existing label would now 422 instead of being adopted. That may well be the better Terraform behavior (import instead of adopt) - just flagging since the checklist says "no behavior change." Totally fine if intentional.

I think this should be Terraform based logic, so fail if the label already exists. We have github_issue_labels to act as an authoritative source.

…nd tflog

slymanmrcan · 2026-06-19T10:30:18Z

Thanks for the review! I’ve pushed the fixes now: color/description are set from Read again, and Create preserves the previous GetLabel-then-EditLabel behavior for existing labels.

deiga · 2026-06-19T17:41:40Z

-	repoName := d.Get("repository").(string)
-	name := d.Get("name").(string)
-	color := d.Get("color").(string)
+// resourceGithubIssueLabelCreate creates an issue label.


Let's not keep comments around if they don't explain something non-obvious

Suggested change

// resourceGithubIssueLabelCreate creates an issue label.

deiga · 2026-06-19T18:27:37Z

+func resourceGithubIssueLabelImport(_ context.Context, d *schema.ResourceData, _ any) ([]*schema.ResourceData, error) {
+	repoName, name, err := parseID2(d.Id())
+	if err != nil {
+		return nil, err


To make the DX nicer, lets add a helpful error message here :)

Suggested change

return nil, err

return nil, fmt.Errorf("Import failed due to ID format mismatch in %s. Please ensure import ID follows the pattern `<repository name>:<label name>.", d.Id())

deiga previously approved these changes Apr 18, 2026

View reviewed changes

deiga added this to the v6.13.0 Release milestone Apr 18, 2026

deiga added the Type: Maintenance Any dependency, housekeeping, and clean up Issue or PR label Apr 18, 2026

slymanmrcan dismissed deiga’s stale review via 6b957e2 April 28, 2026 12:03

deiga added the Awaiting response label Jun 3, 2026

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

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

Copilot AI reviewed Jun 3, 2026

View reviewed changes

Comment thread github/resource_github_issue_label.go Outdated

Comment thread github/resource_github_issue_label.go Outdated

slymanmrcan force-pushed the refactor/migrate-resource-github-issue-label-to-tflog-and-context branch from 241dc85 to 40c2608 Compare June 5, 2026 04:45

deiga previously approved these changes Jun 5, 2026

View reviewed changes

deiga requested a review from stevehipwell June 5, 2026 17:31

stevehipwell requested changes Jun 8, 2026

View reviewed changes

slymanmrcan dismissed deiga’s stale review via 9c162ad June 11, 2026 10:55

slymanmrcan force-pushed the refactor/migrate-resource-github-issue-label-to-tflog-and-context branch from ba9fec5 to 9c162ad Compare June 11, 2026 10:55

stevehipwell requested changes Jun 11, 2026

View reviewed changes

slymanmrcan force-pushed the refactor/migrate-resource-github-issue-label-to-tflog-and-context branch from 9c162ad to ad3d0c9 Compare June 11, 2026 12:16

stevehipwell requested changes Jun 12, 2026

View reviewed changes

slymanmrcan force-pushed the refactor/migrate-resource-github-issue-label-to-tflog-and-context branch from ad3d0c9 to 43498d3 Compare June 13, 2026 13:43

stevehipwell requested changes Jun 15, 2026

View reviewed changes

slymanmrcan force-pushed the refactor/migrate-resource-github-issue-label-to-tflog-and-context branch 4 times, most recently from 88958c6 to 3fef38e Compare June 15, 2026 23:47

stevehipwell requested changes Jun 16, 2026

View reviewed changes

slymanmrcan force-pushed the refactor/migrate-resource-github-issue-label-to-tflog-and-context branch 2 times, most recently from 88e2360 to c20bfef Compare June 17, 2026 21:26

stevehipwell removed the Awaiting response label Jun 18, 2026

stevehipwell previously approved these changes Jun 18, 2026

View reviewed changes

stevehipwell requested review from deiga and robert-crandall June 18, 2026 08:19

deiga previously approved these changes Jun 18, 2026

View reviewed changes

robert-crandall reviewed Jun 18, 2026

View reviewed changes

refactor: migrate resource_github_issue_label to context-aware CRUD a…

9da13ec

…nd tflog

slymanmrcan dismissed stale reviews from deiga and stevehipwell via 9da13ec June 19, 2026 10:28

slymanmrcan force-pushed the refactor/migrate-resource-github-issue-label-to-tflog-and-context branch from c20bfef to 9da13ec Compare June 19, 2026 10:28

deiga requested changes Jun 19, 2026

View reviewed changes

improve issue label import error handling

bce3ab2

	return nil, err
	return nil, fmt.Errorf("Import failed due to ID format mismatch in %s. Please ensure import ID follows the pattern `<repository name>:<label name>.", d.Id())

Conversation

slymanmrcan commented Apr 17, 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 Apr 17, 2026

Uh oh!

deiga commented Apr 18, 2026

Uh oh!

deiga left a comment

Choose a reason for hiding this comment

Uh oh!

slymanmrcan commented Apr 18, 2026

Uh oh!

deiga commented Jun 3, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

slymanmrcan commented Jun 3, 2026

Uh oh!

deiga left a comment

Choose a reason for hiding this comment

Uh oh!

stevehipwell left a comment

Choose a reason for hiding this comment

Uh oh!

slymanmrcan commented Jun 11, 2026

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

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!

slymanmrcan commented Jun 15, 2026

Uh oh!

stevehipwell left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

stevehipwell commented Jun 18, 2026

Uh oh!

stevehipwell left a comment

Choose a reason for hiding this comment

Uh oh!

robert-crandall left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

robert-crandall Jun 18, 2026

Choose a reason for hiding this comment

Uh oh!

stevehipwell Jun 19, 2026

Choose a reason for hiding this comment

Uh oh!

slymanmrcan commented Jun 19, 2026

Uh oh!

deiga Jun 19, 2026

slymanmrcan commented Apr 17, 2026 •

edited

Loading