You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: GNUmakefile
+5-1Lines changed: 5 additions & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -10,9 +10,13 @@ generate:
10
10
go generate ./... &&\
11
11
go run github.com/google/addlicense -c "Circle Internet Group, Inc. All rights reserved." -l "apache" -v -s `find . -name "*.go" -type f -print0 | xargs -0`
Copy file name to clipboardExpand all lines: README.md
+15-2Lines changed: 15 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,6 +2,7 @@
2
2
3
3
This provider allows for managing [Quicknode](https://www.quicknode.com/) resources via Terraform.
4
4
The structure of the repository is outlined below:
5
+
5
6
- Resources and data sources (`internal/provider/`),
6
7
- Examples (`examples/`)
7
8
- Generated documentation (`docs/`),
@@ -31,6 +32,7 @@ go install
31
32
## Using the provider
32
33
33
34
The provider is intended to be configured:
35
+
34
36
```hcl
35
37
terraform {
36
38
required_providers {
@@ -54,18 +56,28 @@ If you wish to work on the provider, you'll first need [Go](http://www.golang.or
54
56
55
57
To compile the provider, run `go install`. This will build the provider and put the provider binary in the `$GOPATH/bin` directory.
56
58
57
-
To generate or update documentation or other generated code, run `make generate`.
59
+
### Updating generated api clients
60
+
61
+
```sh
62
+
# download the open api specs
63
+
make vendor
64
+
65
+
# regenerate the go clients
66
+
make generate
67
+
```
58
68
59
69
### Acceptance Tests
70
+
60
71
In order to run the full suite of Acceptance tests, run `make testacc`, ensuring that the environment variable QUICKNODE_APIKEY is set with an apikey with at least the scope `CONSOLE_REST`.
61
72
62
-
*Note:* Acceptance tests create real resources, and often cost money to run.
73
+
_Note:_ Acceptance tests create real resources, and often cost money to run.
63
74
64
75
```shell
65
76
QUICKNODE_APIKEY="qn_******" make testacc
66
77
```
67
78
68
79
### On My Machine
80
+
69
81
In order to use a compiled provider for a local terraform plan/apply. Configure your `~.terraformrc` as follows:
0 commit comments