A Terraform provider for managing GitHub's IP allow list.
- Clone the repository
- Enter the repository directory
- Build the provider using the Go
install
command:
$ go install
This enables verifying your locally built provider using examples available in the examples/
directory.
Note that you will first need to configure your shell to map our provider to the local build:
export TF_CLI_CONFIG_FILE=path/to/project/examples/dev.tfrc
An example file is available in our examples
directory and resembles:
provider_installation {
dev_overrides {
"from3tech-oss/githubipallowlist" = "~/go/bin/"
}
direct {}
}
See https://www.terraform.io/docs/cli/config/config-file.html for more details.
When running examples, you should spot the following warning to confirm you are using a local build:
Warning: Provider development overrides are in effect
The following provider development overrides are set in the CLI configuration:
- from3tech-oss/githubipallowlist in /Users/somegithuuser/go/bin
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/form3tech-oss/terraform-provider-githubipallowlist
to your Terraform provider:
go get github.com/form3tech-oss/terraform-provider-githubipallowlist
go mod tidy
Then commit the changes to go.mod
and go.sum
.
TBD
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 make testacc
.
Note: Acceptance tests create real resources, and often cost money to run.
$ make testacc