terraform-provider

Terraform Provider for PostHog

Terraform provider for managing PostHog resources.

Documentation

For usage documentation and supported resources, see the Terraform Registry.

Requirements

• Terraform >= 1.0
• Go >= 1.24

Building the Provider

go install

Local Development

The playground/ directory lets you test provider changes locally without publishing.

Setup

1. Create your Terraform config in playground/ (e.g., playground/demo.tf)

2. Build the provider and run terraform:

# Plan changes
make playground-plan

# Apply changes
make playground-apply

This builds the provider binary and configures Terraform to use your local build via dev_overrides - no terraform init required.

Manual Setup

If you prefer to test outside the playground directory:

# Build the provider
make playground-binary

# Point Terraform to your local build
export TF_CLI_CONFIG_FILE=/path/to/terraform-provider-posthog/playground/terraformrc

# Run terraform commands in any directory
terraform plan
terraform apply

Cleanup

make playground-clean

Testing

Unit Tests

go test ./...

Acceptance Tests

Acceptance tests run against a real PostHog instance and create actual resources:

export POSTHOG_API_KEY="your-api-key"
export POSTHOG_PROJECT_ID="12345"
export POSTHOG_HOST="https://us.posthog.com"
export POSTHOG_ORGANIZATION_ID="your-org-uuid"   # Default for organization-scoped resources
export POSTHOG_TEST_USER_EMAIL="user@example.com" # Email of existing org member for membership tests (not the one who owns the token)

make testacc

Generating Documentation

make generate

Releasing

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

# Alpha releases (pre-release, for early testing)
make release-alpha VERSION=1.0.0 NUM=1  # creates v1.0.0-alpha.1

# Beta releases (pre-release, feature complete)
make release-beta VERSION=1.0.0 NUM=1   # creates v1.0.0-beta.1

# Stable releases
make release VERSION=1.0.0              # creates v1.0.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.

License

See LICENSE.