2ac71bf121
* Move and rename files to new structure. * Remove unused front matter. * Rename stray file. * Run terrafmt over examples. |
||
|---|---|---|
| .github | ||
| digitalocean | ||
| docs | ||
| examples | ||
| internal/datalist | ||
| scripts | ||
| vendor | ||
| .gitignore | ||
| .go-version | ||
| .goreleaser.yml | ||
| .travis.yml | ||
| CHANGELOG.md | ||
| GNUmakefile | ||
| LICENSE | ||
| README.md | ||
| go.mod | ||
| go.sum | ||
| main.go | ||
README.md
Terraform Provider
- Website: https://www.terraform.io
- Mailing list: Google Groups
Requirements
Building The Provider
Clone repository to: $GOPATH/src/github.com/digitalocean/terraform-provider-digitalocean
$ mkdir -p $GOPATH/src/github.com/digitalocean; cd $GOPATH/src/github.com/digitalocean
$ git clone git@github.com:digitalocean/terraform-provider-digitalocean
Enter the provider directory and build the provider
$ cd $GOPATH/src/github.com/digitalocean/terraform-provider-digitalocean
$ make build
Using the provider
See the DigitalOcean Provider documentation to get started using the DigitalOcean provider.
Developing the Provider
If you wish to work on the provider, you'll first need Go installed on your machine (version 1.11+ is required). You'll also need to correctly setup a GOPATH, as well as adding $GOPATH/bin to your $PATH.
To compile the provider, run make build. This will build the provider and put the provider binary in the $GOPATH/bin directory.
$ make build
...
$ $GOPATH/bin/terraform-provider-digitalocean
...
In order to test the provider, you can simply run make test.
$ make test
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
In order to run a specific acceptance test, use the TESTARGS environment variable. For example, the following command will run TestAccDigitalOceanDomain_Basic acceptance test only:
$ make testacc TESTARGS='-run=TestAccDigitalOceanDomain_Basic'
For information about writing acceptance tests, see the main Terraform contributing guide.
Releasing the Provider
This repository contains a GitHub Action configured to automatically build and
publish assets for release when a tag is pushed that matches the pattern v*
(ie. v0.1.0).
A Gorelaser configuration is provided that produces build artifacts matching the layout required to publish the provider in the Terraform Registry.
Releases will appear as drafts. Once marked as published on the GitHub Releases page, they will become available via the Terraform Registry.