CONTRIBUTING.md

Contributing

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 the command below:

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

# Ensure these environment variables are set
export TF_ACC: "1" # required to run acceptance tests
export TF_LOG: "INFO" # set log level - optional
export BONSAI_API_KEY="your_bonsai_api_key"
export BONSAI_API_TOKEN="your_bonsai_api_token"
go test -v -cover ./internal/...

Pre-commit

This project uses pre-commit to lint and store 3rd-party dependency licenses. Installation instructions are available on the pre-commit website!

To verify your installation, run this project's pre-commit hooks against all files:

pre-commit run --all-files

Hook dependencies

• Terraform
• Terraform-docs