CONTRIBUTING.md

How to build from source

1. git clone git@github.com:terra-farm/terraform-provider-virtualbox.git
2. cd terraform-provider-virtualbox
3. go build
4. mv terraform-provider-virtualbox examples/
5. cd examples/
6. terraform init
7. terraform plan
8. terraform apply

Debugging

If terraform still uses the preinstalled version you can try to move the binary to the explicit plugins folder, as mentioned in the official terraform documentation or in a terraform tutorial:

mv terraform-provider-virtualbox ~/.terraform.d/plugins/registry.local/local/virtualbox/5.0.0/linux_amd64/terraform-provider-virtualbox_v5.0.0

If you don't want to move the binary all the time you could also use a symbolic link instead:

ln -s terraform-provider-virtualbox ~/.terraform.d/plugins/registry.local/local/virtualbox/5.0.0/linux_amd64/terraform-provider-virtualbox_v5.0.0

You'll have to change the provider in your terraform configuration too:

terraform {
  required_providers {
    virtualbox = {
      source = "registry.local/local/virtualbox",
      version = "5.0.0"
    }
  }
}

Setting the TF_LOG environment variable to DEBUG can also help investigating erros, you can read the official terraform documentation for more details.

Adding documentation

The website is hosted by the official Terraform Registry. The source for the documentation is located in the /website directory. It follows the standard provider documentation format.

Ask the community

If you have a change which you think will benefit the project, ask. This can be either done as a new issue, or by creating a PR with the changes included.

Creating a release

To create a new release for the Terraform Registry, a maintainer only needs to create a new release in the Github UI.

This will automatically publish the release to the Terraform Registry assuming the release Github Action passes.

Updating signing certificate

Please follow the GPG Signing Key guide in the official Terraform Documentation. We try to follow the recommended guides as closely as possible.