Vercel Terraform Provider
- Website: https://www.terraform.io
- Documentation: https://registry.terraform.io/providers/vercel/vercel/latest
Building The Provider
Clone repository locally and run
$ task build
Developing the Provider
If you wish to work on the provider, you'll first need Go installed on your machine (version 1.17+ is required).
To compile the provider, run
task build. This will build the provider and put the provider binary in the repository root.
In addition, you can run
task install to set up a developer overrides in your ~/.terraformrc. This will then allow you to use your locally built provider binary.
When you are finished using a local version of the provider, running
task uninstall will remove all developer overrides.
- HashiCorp - Development Overrides for Provider developers.
In order to test the provider, you can simply run
Note: This runs acceptance tests that will create real resources. You should expect that the full acceptance test suite will take some time to run.
The acceptance tests require a
VERCEL_API_TOKEN (which can be generated here, and a
VERCEL_TERRAFORM_TESTING_TEAM (which should be a Vercel team_id where resources can be created and destroyed) environment variable set.
$ task test
In order to run the tests with extra debugging context, prefix with
TF_LOG (see the terraform documentation for details).
$ TF_LOG=trace task test
Building The Documentation
The documentation is autogenerated from Description fields within the provider, and the
examples directory. Building the documentation generates markdown in the
docs folder, ready for deployment to Hashicorp.
- To view the documentation: Paste
/docsMarkdown file content into https://registry.terraform.io/tools/doc-preview