Skip to content

Latest commit

 

History

History
101 lines (75 loc) · 3.51 KB

README.md

File metadata and controls

101 lines (75 loc) · 3.51 KB
Raw

cloudscale.ch Terraform Provider

Requirements

  • Terraform 0.12 or higher
  • Go to build the provider plugin

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 -mod vendor. 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.

Notes:

  • Acceptance tests create real resources, and often cost money to run.
  • See here to understand which version of Terraform is used in your tests.
$ make testacc

In order to run a subset of the tests:

$ TESTARGS="-run TestAccCloudscaleSubnet" make testacc

In order to upgrade the cloudscale-go-sdk.

go get -u github.com/cloudscale-ch/cloudscale-go-sdk
go mod vendor

Use the following commands to switch to a local version of the go-sdk and back:

go mod edit -replace "github.com/cloudscale-ch/cloudscale-go-sdk/v4=../cloudscale-go-sdk/"
go mod vendor
git commit -m "drop: Use local version of cloudscale-go-sdk"
go mod edit -dropreplace "github.com/cloudscale-ch/cloudscale-go-sdk/v4"
go mod vendor

To test unreleased driver versions locally add the following to your ~/.terraformrc

provider_installation {
  # Use go/bin as an overridden package directory
  # for the cloudscale-ch/cloudscale provider. This disables the version and checksum
  # verifications for this provider and forces Terraform to look for the
  # null provider plugin in the given directory.
  dev_overrides {
    "cloudscale-ch/cloudscale" = "/Users/alain/go/bin"
  }

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

To cross-compile a local build, run:

# goreleaser v1.x
docker run -it --rm -v $PWD:/app --workdir=/app goreleaser/goreleaser:v1.26.2 release --snapshot --rm-dist --skip-sign
# goreleaser v2.x
docker run -it --rm -v $PWD:/app --workdir=/app goreleaser/goreleaser:v2.1.0 release --snapshot --clean --skip=publish,sign

Releasing the Provider

  1. Ensure the CHANGELOG.md is up-to-date.
  2. Create a new release on GitHub. Both the tag and release title must follow this pattern: v<<SEMVER>>. Examples: v42.43.44 or v1.33.7-rc.1.
  3. It might take a moment until the release appears in the Terraform registry. You can manually resync the provider when you are logged in to the registry.

Developing the Documentation Website

Use the Terraform doc preview tool to test markdown rendering.