terraform-provider-heroku

command module
Version: v4.6.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 14, 2021 License: MPL-2.0 Imports: 2 Imported by: 0

README

Terraform Provider Heroku

Acceptance tests

This provider is used to configure resources supported by the Heroku Platform API.

See the official documentation to use this provider in a Terraform configuration.

Requirements

  • Terraform 0.12.x
  • Go 1.15 (to build the provider plugin)

Usage

For Terraform 0.11 compatibility, the configuration should specify version 3 or lower:

provider "heroku" {
  version = "~> 3.0"
}

Otherwise, the configuration should specify version 4 or higher:

provider "heroku" {
  version = "~> 4.0"
}

👓📚 For more usage info, see Heroku Provider docs.

Development

If you wish to work on the provider, you'll first need Go installed on your machine (version 1.15+ is required). You'll also need to correctly setup a GOPATH, as well as adding $GOPATH/bin to your $PATH.

Clone the Provider

With Go language, the repository must be cloned to a specific path in $GOPATH/src that matches its module import path.

mkdir -p $GOPATH/src/github.com/heroku
cd $GOPATH/src/github.com/heroku
git clone git@github.com:heroku/terraform-provider-heroku
Build the Provider

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-heroku
...
Using the Provider

To use the dev provider with local Terraform, configure a dev override pointing to the directory where terraform-provider-heroku can be found:

cat << TRC >> ~/.terraformrc
provider_installation {
  dev_overrides {
    "heroku/heroku" = "$GOPATH/bin"
  }
  direct {}
}
TRC
Terraform Versions Prior to 0.13

Copy the freshly built plugin into Terraform's local plugins directory:

cp $GOPATH/bin/terraform-provider-heroku ~/.terraform.d/plugins/

Set the Heroku provider without a version constraint:

provider "heroku" {}

Then, initialize Terraform:

terraform init
Testing

Please see the TESTING guide for detailed instructions on running tests.

Updating or adding dependencies

This project uses Go Modules for dependency management.

Dependencies can be added or updated as follows:

$ GO111MODULE=on go get github.com/some/module@release-tag
$ GO111MODULE=on go mod tidy
$ GO111MODULE=on go mod vendor

This example will fetch a module at the release tag and record it in your project's go.mod and go.sum files. It's a good idea to tidy up afterward and then copy the dependencies into vendor/.

If a module does not have release tags, then module@master can be used instead.

Removing dependencies

Remove all usage from your codebase and run:

$ GO111MODULE=on go mod tidy
$ GO111MODULE=on go mod vendor

Documentation

The Go Gopher

There is no documentation for this package.

Source Files

Directories

Path Synopsis
helper

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
t or T : Toggle theme light dark auto
y or Y : Canonical URL