Official documentation on how to use this provider can be found on the Terraform Registry.
- Terraform (>= 0.12)
- Go (1.17)
- GNU Make
- golangci-lint (optional)
git clone
this repository andcd
into its directorymake build
will trigger the Golang build
The provided GNUmakefile
defines additional commands generally useful during development,
like for running tests, generating documentation, code formatting and linting.
Taking a look at it's content is recommended.
In order to test the provider, you can run
make test
to run provider testsmake testacc
to run provider acceptance tests
It's important to note that acceptance tests (testacc
) will actually spawn
terraform
and the provider. Read more about they work on the
official page.
This provider uses terraform-plugin-docs
to generate documentation and store it in the docs/
directory.
Once a release is cut, the Terraform Registry will download the documentation from docs/
and associate it with the release version. Read more about how this works on the
official page.
Use make docs-generate
to ensure the documentation is regenerated with any changes.
If running tests and acceptance tests isn't enough, it's possible to set up a local terraform configuration to use a development builds of the provider.
First, use make install
to place a fresh development build of the provider in your ${HOME}/.terraform.d/plugins
(Unix)
The release process is automated via GitHub Actions, and it's defined in the Workflow release.yml.
Each release is cut by pushing a semantically versioned tag to the default branch.