Skip to content

Commit 163b756

Browse files
authored
chore(docs): improvove contributing docs for local development builds (#617)
Signed-off-by: Nathanael Liechti <[email protected]>
1 parent 69c65a0 commit 163b756

File tree

1 file changed

+17
-3
lines changed

1 file changed

+17
-3
lines changed

CONTRIBUTING.md

Lines changed: 17 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -64,9 +64,23 @@ your
6464
(defaults to `${GOPATH}/bin` or `${HOME}/go/bin` if `${GOPATH}` is not set).
6565
Repeat this every time you make changes to the provider locally.
6666

67-
Then, setup your environment following [these
68-
instructions](https://www.terraform.io/plugin/debugging#terraform-cli-development-overrides)
69-
to make your local terraform use your local build.
67+
Then write this config to a file:
68+
```hcl filename="../reproduce/.terraformrc"
69+
provider_installation {
70+
dev_overrides {
71+
"argoproj-labs/argocd" = "/Users/username/go/bin" # path must be absolute and point to the directoy containing the binary
72+
}
73+
74+
direct {}
75+
}
76+
```
77+
78+
And lastly use the following environment variable in a terminal session to tell Terraform to use this file for picking up the development binary:
79+
```console
80+
export TF_CLI_CONFIG_FILE=../.reproduce/.terraformrc
81+
```
82+
83+
For further reference consult [HashiCorp's article](https://www.terraform.io/plugin/debugging#terraform-cli-development-overrides) about this topic.
7084

7185
## Debugging
7286

0 commit comments

Comments
 (0)