Skip to content

docs: update README note for local provider testing with correct module path #403

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
May 21, 2025
Merged

docs: update README note for local provider testing with correct module path #403

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7d37f54
docs: update README note for local provider testing with correct modu…
ssncferreira May 21, 2025
ddd57b9
docs: improve sentence structure
ssncferreira May 21, 2025
8231a8d
docs: remove extra backtick
ssncferreira May 21, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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, 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
```
⚠️ 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

Expand Down