Terraform Provider Scaffolding (Terraform Plugin Framework)

This template repository is built on the Terraform Plugin Framework. The template repository built on the Terraform Plugin SDK can be found at terraform-provider-scaffolding. See Which SDK Should I Use? in the Terraform documentation for additional information.

This repository is a template for a Terraform provider. It is intended as a starting point for creating Terraform providers, containing:

• A resource and a data source (internal/provider/),
• Examples (examples/) and generated documentation (docs/),
• Miscellaneous meta files.

These files contain boilerplate code that you will need to edit to create your own Terraform provider. Tutorials for creating Terraform providers can be found on the HashiCorp Developer platform. Terraform Plugin Framework specific guides are titled accordingly.

Please see the GitHub template repository documentation for how to create a new repository from this template on GitHub.

Once you've written your provider, you'll want to publish it on the Terraform Registry so that others can use it.

Requirements

• Terraform >= 1.0
• Go >= 1.24

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

Configure the provider with your PostHog host, personal API key, and default project/environment ID. All resources inherit this project scope.

provider "posthog" {
  host       = "https://us.posthog.com"
  api_key    = var.posthog_api_key
  project_id = var.posthog_project_id
}

resource "posthog_insight" "weekly_signups" {
  name        = "Weekly signups"
  description = "Tracks sign up volume per week"
  derived_name = "Weekly signups"

  query_json = jsonencode({
    kind   = "InsightVizNode"
    source = {
      kind   = "TrendsQuery"
      series = [{
        kind= "EventsNode"
        name = "$pageview"
        event = "$pageview"
        math= "total"
      }]
      version = 2
      trendsFilter = {}
    }
  })
  tags = ["managed-by:terraform"]
  create_in_folder = "Unfiled/Insights"
}

To import an existing insight, run:

terraform import posthog_insight.weekly_signups "<insight_id>"

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

Releasing

Releases are automated via GoReleaser when a signed tag is pushed. The Makefile provides convenience targets for creating releases:

# Alpha releases (pre-release, for early testing)
make release-alpha VERSION=0.1.0 NUM=1  # creates v0.1.0-alpha.1

# Beta releases (pre-release, feature complete)
make release-beta VERSION=0.1.0 NUM=1   # creates v0.1.0-beta.1

# Stable releases
make release VERSION=0.1.0              # creates v0.1.0

Requirements:

• GPG key configured for signing (git tag -s)
• GPG key added to your GitHub account (for the "Verified" badge)

Pre-release versions (alpha, beta) won't be installed by default — users must explicitly pin to them in their Terraform configuration.