From 7d37f54050ab99f7d54dca09207c92ade29349a1 Mon Sep 17 00:00:00 2001 From: Susana Ferreira Date: Wed, 21 May 2025 10:35:32 +0000 Subject: [PATCH 1/3] docs: update README note for local provider testing with correct module path --- README.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index f055961e..54f9f887 100644 --- a/README.md +++ b/README.md @@ -49,7 +49,13 @@ to setup your local Terraform to use your local version rather than the registry 2. Run `terraform init` and observe a warning like `Warning: Provider development overrides are in effect` 4. Run `make build` to build the provider binary, which Terraform will try locate and execute 5. All local Terraform runs will now use your local provider! -6. _**NOTE**: we vendor in this provider into `github.com/coder/coder`, so if you're testing with a local clone then you should also run `go mod edit -replace github.com/coder/terraform-provider-coder=/path/to/terraform-provider-coder` in your clone._ +6. **NOTE**: We vendor this provider into `github.com/coder/coder`, so if you're testing with a local clone then you should also run: + ```console + go mod edit -replace github.com/coder/terraform-provider-coder/v2=/path/to/terraform-provider-coder` + go mod tidy + ``` + ⚠️ Be sure to include `/v2` in the module path as it needs to match the version declared in the provider’s `go.mod`. + #### Terraform Acceptance Tests From ddd57b991b8a1b44dfb4d0d7261c437d12cd2eaf Mon Sep 17 00:00:00 2001 From: Susana Ferreira Date: Wed, 21 May 2025 10:45:48 +0000 Subject: [PATCH 2/3] docs: improve sentence structure --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 54f9f887..9a498960 100644 --- a/README.md +++ b/README.md @@ -49,7 +49,7 @@ to setup your local Terraform to use your local version rather than the registry 2. Run `terraform init` and observe a warning like `Warning: Provider development overrides are in effect` 4. Run `make build` to build the provider binary, which Terraform will try locate and execute 5. All local Terraform runs will now use your local provider! -6. **NOTE**: We vendor this provider into `github.com/coder/coder`, so if you're testing with a local clone then you should also run: +6. **NOTE**: We vendor this provider into `github.com/coder/coder`, so if you're testing with a local clone, make sure to run the following in your local clone of `coder`: ```console go mod edit -replace github.com/coder/terraform-provider-coder/v2=/path/to/terraform-provider-coder` go mod tidy From 8231a8db8bc1efb8c388df67f8963ada43188f38 Mon Sep 17 00:00:00 2001 From: Susana Ferreira Date: Wed, 21 May 2025 10:48:02 +0000 Subject: [PATCH 3/3] docs: remove extra backtick --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 9a498960..4ae9be15 100644 --- a/README.md +++ b/README.md @@ -51,7 +51,7 @@ to setup your local Terraform to use your local version rather than the registry 5. All local Terraform runs will now use your local provider! 6. **NOTE**: We vendor this provider into `github.com/coder/coder`, so if you're testing with a local clone, make sure to run the following in your local clone of `coder`: ```console - go mod edit -replace github.com/coder/terraform-provider-coder/v2=/path/to/terraform-provider-coder` + go mod edit -replace github.com/coder/terraform-provider-coder/v2=/path/to/terraform-provider-coder go mod tidy ``` ⚠️ Be sure to include `/v2` in the module path as it needs to match the version declared in the provider’s `go.mod`.