public/terraform-provider-google
0
0
Fork 0
mirror of https://github.com/letic/terraform-provider-google.git synced 2024-07-01 07:42:40 +00:00
Code Issues Projects Releases Wiki Activity

Add docs about local provider to CONTRIBUTING (#2085)

Browse Source 
* Add docs about local provider to CONTRIBUTING

Add docs about using a local provider with Terraform to CONTRIBUTING.md.

I couldn't find any prescriptive docs for this, so let's make them. Let me know if a different method is preferred (such as `.terraformrc`), this seemed like the best way from my brief search.

Upstreamed https://github.com/hashicorp/terraform-website/pull/474 as well to help improve the central Terraform docs on this subject.

* Update CONTRIBUTING.md (#2086)
This commit is contained in:
Riley Karson 2018-09-20 12:40:10 -07:00 committed by GitHub
parent 80e03f7f28
commit cab802db6b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 16 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
.github/CONTRIBUTING.md vendored
View File

@ -67,6 +67,22 @@ resource.TestStep{
},
```
## Running a local copy of the provider
If you are building Terraform from source with a Google provider built from source, Terraform will automatically use the
local `terraform-provider-google` plugin in `$GOPATH/bin`.
In order to use a release copy of Terrafom with a local provider, you can use the [provider discovery directory](https://www.terraform.io/docs/extend/how-terraform-works.html#discovery)
at `~/.terraform.d/plugins`. When a copy of the Google provider is present in the discovery directory, `terraform init` will
use that copy instead of downloading a release version.
To use a single locally built version, such as one built by a CI or build server, you can copy a `terraform-provider-google`
binary into the discovery directory. If you're testing a local provider in active development and want the new binary each
time you run `make build`, you can symlink the built binary into the directory:
```bash
ln -s $GOPATH/bin/terraform-provider-google ~/.terraform.d/plugins/terraform-provider-google
```
## Autogenerated Resources
Some resources in the Google provider are autogenerated using the [Magic Modules](https://github.com/GoogleCloudPlatform/magic-modules) framework, and have a large disclaimer as a comment at the top of their files to say so. For feature requests or bugs regarding those resources, please continue to file [issues](https://github.com/terraform-providers/terraform-provider-google/issues) here. PRs changing those resources will not be accepted.