Merge branch 'av/import-tf' into av/import-identity-tf

austinvalle · web-flow · commit 5d4c555554ce · 2025-06-25T17:36:05.000-04:00
diff --git a/.changes/unreleased/FEATURES-20250616-181322.yaml b/.changes/unreleased/FEATURES-20250616-181322.yaml
@@ -1,5 +1,5 @@
 kind: FEATURES
-body: 'generate: Added support for defining import examples using Terraform configuration and the `id` attribute'
+body: 'generate: Added support for defining import example file (`import-by-string-id.tf`) using Terraform configuration and the `id` attribute'
 time: 2025-06-16T18:13:22.627319-04:00
 custom:
     Issue: "472"
diff --git a/.github/dependabot.yml b/.github/dependabot.yml
@@ -6,7 +6,6 @@ updates:
     schedule:
       # Check for updates to Go modules every weekday
       interval: "daily"
-
   # Maintain dependencies for Go modules (tools)
   - package-ecosystem: "gomod"
     directory: "/tools"
@@ -15,5 +14,12 @@ updates:
       interval: "daily"
   - package-ecosystem: "github-actions"
     directory: "/"
+    groups:
+      "github-actions":
+        patterns:
+          - "*" # Group all GitHub Actions dependencies together
     schedule:
-      interval: "daily"
+      interval: "weekly"
+      day: "monday"
+      time: "09:00"
+      timezone: "Etc/UTC"
diff --git a/README.md b/README.md
@@ -232,7 +232,7 @@ For examples:
 | `examples/functions/<function name>/function.tf`                          | Function example config              |
 | `examples/resources/<resource name>/resource.tf`                          | Resource example config              |
 | `examples/resources/<resource name>/import.sh`                            | Resource example import command      |
-| `examples/resources/<resource name>/import-id.tf`                         | Resource example import by id config |
+| `examples/resources/<resource name>/import-by-string-id.tf`               | Resource example import by id config |
 
 #### Migration
 
diff --git a/cmd/tfplugindocs/testdata/scripts/provider-build/generate/framework_provider_success_generic_templates.txtar b/cmd/tfplugindocs/testdata/scripts/provider-build/generate/framework_provider_success_generic_templates.txtar
@@ -145,7 +145,7 @@ ExampleFile: $WORK/examples/resources/scaffolding_example/resource.tf
 HasImport: true
 ImportFile: $WORK/examples/resources/scaffolding_example/import.sh
 HasImportIDConfig: true
-ImportIDConfigFile: $WORK/examples/resources/scaffolding_example/import-id.tf
+ImportIDConfigFile: $WORK/examples/resources/scaffolding_example/import-by-string-id.tf
 ProviderName: terraform-provider-scaffolding
 ProviderShortName: scaffolding
 RenderedProviderName: terraform-provider-scaffolding
@@ -375,7 +375,7 @@ data "scaffolding_example" "example" {
 provider "scaffolding" {
   # example configuration here
 }
--- examples/resources/scaffolding_example/import-id.tf --
+-- examples/resources/scaffolding_example/import-by-string-id.tf --
 import {
   to = scaffolding_example.example
   id = "id-123"
diff --git a/cmd/tfplugindocs/testdata/scripts/provider-build/generate/framework_provider_success_named_templates.txtar b/cmd/tfplugindocs/testdata/scripts/provider-build/generate/framework_provider_success_named_templates.txtar
@@ -145,7 +145,7 @@ ExampleFile: $WORK/examples/resources/scaffolding_example/resource.tf
 HasImport: true
 ImportFile: $WORK/examples/resources/scaffolding_example/import.sh
 HasImportIDConfig: true
-ImportIDConfigFile: $WORK/examples/resources/scaffolding_example/import-id.tf
+ImportIDConfigFile: $WORK/examples/resources/scaffolding_example/import-by-string-id.tf
 ProviderName: terraform-provider-scaffolding
 ProviderShortName: scaffolding
 RenderedProviderName: terraform-provider-scaffolding
@@ -375,7 +375,7 @@ data "scaffolding_example" "example" {
 provider "scaffolding" {
   # example configuration here
 }
--- examples/resources/scaffolding_example/import-id.tf --
+-- examples/resources/scaffolding_example/import-by-string-id.tf --
 import {
   to = scaffolding_example.example
   id = "id-123"
diff --git a/cmd/tfplugindocs/testdata/scripts/provider-build/generate/framework_provider_success_no_templates.txtar b/cmd/tfplugindocs/testdata/scripts/provider-build/generate/framework_provider_success_no_templates.txtar
@@ -163,7 +163,7 @@ data "scaffolding_example" "example" {
 provider "scaffolding" {
   # example configuration here
 }
--- examples/resources/scaffolding_example/import-id.tf --
+-- examples/resources/scaffolding_example/import-by-string-id.tf --
 import {
   to = scaffolding_example.example
   id = "id-123"
diff --git a/cmd/tfplugindocs/testdata/scripts/schema-json/generate/framework_provider_success_generic_templates.txtar b/cmd/tfplugindocs/testdata/scripts/schema-json/generate/framework_provider_success_generic_templates.txtar
@@ -194,7 +194,7 @@ ExampleFile: $WORK/examples/resources/scaffolding_example/resource.tf
 HasImport: true
 ImportFile: $WORK/examples/resources/scaffolding_example/import.sh
 HasImportIDConfig: true
-ImportIDConfigFile: $WORK/examples/resources/scaffolding_example/import-id.tf
+ImportIDConfigFile: $WORK/examples/resources/scaffolding_example/import-by-string-id.tf
 ProviderName: terraform-provider-scaffolding
 ProviderShortName: scaffolding
 RenderedProviderName: terraform-provider-scaffolding
@@ -588,7 +588,7 @@ provider "scaffolding" {
 resource "scaffolding_example" "example" {
   configurable_attribute = "some-value"
 }
--- examples/resources/scaffolding_example/import-id.tf --
+-- examples/resources/scaffolding_example/import-by-string-id.tf --
 import {
   to = scaffolding_example.example
   id = "id-123"
diff --git a/cmd/tfplugindocs/testdata/scripts/schema-json/generate/framework_provider_success_legacy_docs.txtar b/cmd/tfplugindocs/testdata/scripts/schema-json/generate/framework_provider_success_legacy_docs.txtar
@@ -196,7 +196,7 @@ resource "scaffolding_example" "example" {
 resource "scaffolding_example" "example" {
   configurable_attribute = "some-value"
 }
--- examples/resources/scaffolding_example/import-id.tf --
+-- examples/resources/scaffolding_example/import-by-string-id.tf --
 import {
   to = scaffolding_example.example
   id = "id-123"
diff --git a/cmd/tfplugindocs/testdata/scripts/schema-json/generate/framework_provider_success_named_templates.txtar b/cmd/tfplugindocs/testdata/scripts/schema-json/generate/framework_provider_success_named_templates.txtar
@@ -193,7 +193,7 @@ ExampleFile: $WORK/examples/resources/scaffolding_example/resource.tf
 HasImport: true
 ImportFile: $WORK/examples/resources/scaffolding_example/import.sh
 HasImportIDConfig: true
-ImportIDConfigFile: $WORK/examples/resources/scaffolding_example/import-id.tf
+ImportIDConfigFile: $WORK/examples/resources/scaffolding_example/import-by-string-id.tf
 ProviderName: terraform-provider-scaffolding
 ProviderShortName: Scaffolding
 RenderedProviderName: Scaffolding
@@ -591,7 +591,7 @@ resource "scaffolding_example" "example" {
 resource "scaffolding_example" "example" {
   configurable_attribute = "some-value"
 }
--- examples/resources/scaffolding_example/import-id.tf --
+-- examples/resources/scaffolding_example/import-by-string-id.tf --
 import {
   to = scaffolding_example.example
   id = "id-123"
diff --git a/cmd/tfplugindocs/testdata/scripts/schema-json/generate/framework_provider_success_no_templates.txtar b/cmd/tfplugindocs/testdata/scripts/schema-json/generate/framework_provider_success_no_templates.txtar
@@ -296,7 +296,7 @@ output "test" {
 provider "scaffolding" {
   # example configuration here
 }
--- examples/resources/scaffolding_example/import-id.tf --
+-- examples/resources/scaffolding_example/import-by-string-id.tf --
 import {
   to = scaffolding_example.example
   id = "id-123"
diff --git a/cmd/tfplugindocs/testdata/scripts/schema-json/generate/framework_provider_success_static_files.txtar b/cmd/tfplugindocs/testdata/scripts/schema-json/generate/framework_provider_success_static_files.txtar
@@ -196,7 +196,7 @@ resource "scaffolding_example" "example" {
 resource "scaffolding_example" "example" {
   configurable_attribute = "some-value"
 }
--- examples/resources/scaffolding_example/import-id.tf --
+-- examples/resources/scaffolding_example/import-by-string-id.tf --
 import {
   to = scaffolding_example.example
   id = "id-123"
diff --git a/internal/provider/generate.go b/internal/provider/generate.go
@@ -645,7 +645,7 @@ func (g *generator) renderStaticWebsite(providerSchema *tfjson.ProviderSchema) e
 			resIdentitySchema := resourceIdentitySchema(providerSchema.ResourceIdentitySchemas, shortName, relFile)
 			exampleFilePath := filepath.Join(g.ProviderExamplesDir(), "resources", resName, "resource.tf")
 			importFilePath := filepath.Join(g.ProviderExamplesDir(), "resources", resName, "import.sh")
-			importIDConfigFilePath := filepath.Join(g.ProviderExamplesDir(), "resources", resName, "import-id.tf")
+			importIDConfigFilePath := filepath.Join(g.ProviderExamplesDir(), "resources", resName, "import-by-string-id.tf")
 			importIdentityConfigFilePath := filepath.Join(g.ProviderExamplesDir(), "resources", resName, "import-identity.tf")
 
 			if resSchema != nil {

Original file line number	Diff line number	Diff line change
`@@ -163,7 +163,7 @@ data "scaffolding_example" "example" {`
`163`	`163`	`provider "scaffolding" {`
`164`	`164`	`# example configuration here`
`165`	`165`	`}`
`166`		`--- examples/resources/scaffolding_example/import-id.tf --`
	`166`	`+-- examples/resources/scaffolding_example/import-by-string-id.tf --`
`167`	`167`	`import {`
`168`	`168`	`to = scaffolding_example.example`
`169`	`169`	`id = "id-123"`
Original file line number	Diff line number	Diff line change
`@@ -196,7 +196,7 @@ resource "scaffolding_example" "example" {`
`196`	`196`	`resource "scaffolding_example" "example" {`
`197`	`197`	`configurable_attribute = "some-value"`
`198`	`198`	`}`
`199`		`--- examples/resources/scaffolding_example/import-id.tf --`
	`199`	`+-- examples/resources/scaffolding_example/import-by-string-id.tf --`
`200`	`200`	`import {`
`201`	`201`	`to = scaffolding_example.example`
`202`	`202`	`id = "id-123"`
Original file line number	Diff line number	Diff line change
`@@ -296,7 +296,7 @@ output "test" {`
`296`	`296`	`provider "scaffolding" {`
`297`	`297`	`# example configuration here`
`298`	`298`	`}`
`299`		`--- examples/resources/scaffolding_example/import-id.tf --`
	`299`	`+-- examples/resources/scaffolding_example/import-by-string-id.tf --`
`300`	`300`	`import {`
`301`	`301`	`to = scaffolding_example.example`
`302`	`302`	`id = "id-123"`