Skip to content

Commit

Permalink
chore(docs): add dev instructions to README
Browse files Browse the repository at this point in the history
  • Loading branch information
leggetter committed Aug 8, 2024
1 parent 15d429a commit 96aacb1
Showing 1 changed file with 25 additions and 0 deletions.
25 changes: 25 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,3 +53,28 @@ resource "hookdeck_connection" "my_connection" {
## Dependencies

This provider uses [Hookdeck API](https://hookdeck.com/api-ref) and [Hookdeck Go SDK](https://github.com/hookdeck/hookdeck-go-sdk) under the hood.

## Development

To test the provider during development, read the [HashiCorp providers plugin framework guide](https://developer.hashicorp.com/terraform/tutorials/providers-plugin-framework/providers-plugin-framework-provider).

In short:

1. Configure golang installation directory properly
2. Run `go build`
3. run “go install .” to build the terraform plugin executable file (do this every time code changes)
4. In “homedirectory/.terraformrc” point the hookdeck provider to a local installation
```
provider_installation {
dev_overrides {
# often /Users/<username>/go/bin
"hookdeck/hookdeck" = "path/to/go/package/install/directory"
}
# For all other providers, install them directly from their origin provider
# registries as normal. If you omit this, Terraform will _only_ use
# the dev_overrides block, and so no other providers will be available.
direct {}
}
```

0 comments on commit 96aacb1

Please sign in to comment.