Skip to content

HelloAsso/terraform-provider-helloasso

Repository files navigation

Terraform Provider HelloAsso

This repository is built on the [Terraform Plugin Framework](https://github.com/hashicorp/ From template Terraform Provider Scaffolding

Requirements

  • Terraform >= 1.0
  • Go >= 1.18
  • An app registration in Azure AD having role permission Azure Devops

Building The Provider

  1. Clone the repository
  2. Enter the repository directory
  3. Build the provider using the Go install command:
go install

Adding Dependencies

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/author/dependency to your Terraform provider:

go get github.com/author/dependency
go mod tidy

Then commit the changes to go.mod and go.sum.

Using the provider

Fill this in for each provider

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

Run "go generate" to format example terraform files and generate the docs for the registry/website

If you do not have terraform installed, you can remove the formatting command, but its suggested to ensure the documentation is formatted properly. go:generate terraform fmt -recursive ./examples/

Run the docs generation tool, check its repository for more information on how it works and how docs can be customized. go:generate go run github.com/hashicorp/terraform-plugin-docs/cmd/tfplugindocs

Debugging the provider locally

Follow https://developer.hashicorp.com/terraform/tutorials/providers-plugin-framework/providers-plugin-framework-provider

Once the provider binary installed locally on your machine, launch it with -debug

terraform-provider-helloasso -debug

It will start and display an env variable: TF_REATTACH_PROVIDERS='{....}'

Start your terraform command by providing this env var:

TF_REATTACH_PROVIDERS='{....}' terraform plan