integrations / terraform-provider-github

Terraform GitHub provider
https://www.terraform.io/docs/providers/github/
MIT License
888 stars 729 forks source link

[BUG]: github_repository_file import not setting branch argument correctly #2020

Closed rhughes1 closed 2 weeks ago

rhughes1 commented 10 months ago

Expected Behavior

Expected to see the branch argument populated with the Terraform state file and that the plan would not force replace the resource.

Actual Behavior

The Terraform state file recorded the branch as null. When a terraform plan occurs after the import, Terraform wants to force replace the resource.

  # github_repository_file.readme must be replaced
  # (imported from "test-import/README.md")
  # Warning: this will destroy the imported resource
-/+ resource "github_repository_file" "readme" {
      + branch              = "main" # forces replacement
      ~ commit_message      = "Initial commit of the module" -> "chore: Update repository scaffolding"
      ~ commit_sha          = "10d7666466de45cf1d2468bb4c201d8edb752b28" -> (known after apply)
      ~ id                  = "test-import/README.md" -> (known after apply)
      ~ overwrite_on_create = false -> true
      ~ ref                 = "main" -> (known after apply)
        repository          = "test-import"
      ~ sha                 = "c05f3f5777527c4f852f9f03d3f83gh18671a01f" -> (known after apply)
    }

Looking at the import logic, it only seems to set the branch if you import specifying the branch (ie with a :). However, when I do specify the branch within the import (ie test-import/README:main as the ID in the CLI or import configuration) it still shows as a force replacement.

The logic should set the branch if the default branch is being used explicitly.

Terraform Version

Terraform v1.6.3 integrations/github v5.42.0

Affected Resource(s)

Terraform Configuration Files

import {
  id = "testorg/README.md"
  to = "github_repository_file.readme"
}

resource "github_repository_file" "readme" {
  repository = "test-import"
  branch     = "main"
  file       = "README.md"
  content    = "I'm a README file"
  commit_message      = "testing import"
  commit_author       = "test"
  commit_email        = "test@test.com"
  overwrite_on_create = true
}

Steps to Reproduce

  1. Import a file off of the repository's default branch (ie main). This can be done either with the Terraform CLI using terraform import github_repository_file.readme testorg/README.md or the Terraform import configuration.
  2. Run a terraform plan

Debug Output

No response

Panic Output

No response

Code of Conduct

github-actions[bot] commented 10 months ago

👋 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 labled with Status: Up for grabs. You & others like you are the reason all of this works! So thank you & happy coding! 🚀

chris3ware commented 10 months ago

I believe #1128 may have caused this because v5.19.0 works ok, but v5.20.0 wants to replace all my github_repository_file_resources because the branch has changed from main => null.

However, providing the branch argument fixes this.

github-actions[bot] commented 3 weeks ago

👋 Hey Friends, this issue has been automatically marked as stale because it has no recent activity. It will be closed if no further activity occurs. Please add the Status: Pinned label if you feel that this issue needs to remain open/active. Thank you for your contributions and help in keeping things tidy!