Terraform Provider Designation (Terraform Plugin Framework)

Requirements

• Terraform >= 1.0
• Go >= 1.17

Building The Provider

1. Clone the repository
2. Enter the repository directory
3. Build the provider using the Go install command:

go install

Adding Dependencies

This provider uses Go modules. Please see the Go documentation for the most up to date information about using Go modules.

To add a new dependency github.com/author/dependency to your Terraform provider:

go get github.com/author/dependency
go mod tidy

Then commit the changes to go.mod and go.sum.

Developing the Provider

If you wish to work on the provider, you'll first need Go installed on your machine (see Requirements above).

To compile the provider, run go install. This will build the provider and put the provider binary in the $GOPATH/bin directory.

To generate or update documentation, run go generate.

In order to run the full suite of Acceptance tests, run make testacc.

Note: Acceptance tests create real resources, and often cost money to run.

make testacc

Local Test

There is a makefile to build the provider and place it in repos root dir.

make

To use the local build version you need to tell terraform where to look for it via a terraform config override.

Create dev.tfrc in your terraform code folder (e.g. in dev.tfrc):

# dev.tfrc
provider_installation {
  dev_overrides {
    "datadrivers/designation" = "../../"
  }

  # 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 {}
}

Tell your shell environment to use override file:

export TF_CLI_CONFIG_FILE=dev.tfrc

Now run your terraform commands (plan or apply), init is not required.

# run local terraform code
cd examples/development
terraform plan
terraform apply

Create Release

cz bump --changelog
git push --tags