Skip to Content
DocumentationPublish Terraform Provider

Terraform Registry

You can configure the Speakeasy Generation GitHub Action to publish a generated Terraform provider. However, you cannot generate a Terraform provider with Speakeasy while operating in monorepo mode. You need a separate repository for the Terraform provider and the repository must be named using the appropriate name format.

Use the following steps to publish a generated Terraform provider to the HashiCorp Terraform Registry.

  1. Create a repository for the Terraform provider:

    • Name the repository terraform-provider-{NAME}, with the NAME containing lowercase letters.
    • Ensure it is a public repository.

  2. Sign your Terraform provider releases with a signing key. Create and export a GNU Privacy Guard (GPG) signing key following the instructions in the GitHub guide to Generating a new GPG key . Generate your GPG key using either the Digital Signature Algorithm (DSA) or the Rivest–Shamir–Adleman (RSA) algorithm.

  3. Take note of the following values:

    • The GPG private key.
    • The GPG passphrase.
    • The GPG public key.

  4. Add the ASCII-armored public key to the Terraform repository.

  5. Your GPG private key and GPG passphrase will be configured automatically when entered into the Speakeasy CLI. Ensure the following secrets are available to your repository:

    • The GPG private key, terraform_gpg_secret_key.
    • The GPG passphrase, terraform_gpg_passphrase.

  6. The first time you create and publish a Terraform provider using the Speakeasy Generation GitHub Action, you need to manually add it to the Terraform Registry. Subsequent updates will be published automatically. To begin this process, follow the Terraform Registry instructions  and agree to the Terraform terms and conditions. Note that you will need to be an organizational admin to complete this step.

  7. Add the following file to your .github/workflows directory to indicate create releases for your Terraform provider using GoReleaser. If all the above steps have been completed, the HashiCorp registry will automatically pick up new changes.

  8. Finally, create a GoReleaser  file in the root of your repository:

Whenever you generate and merge a new PR for your Terraform provider, it will be automatically versioned and released to the HashiCorp Registry.

Last updated on
Generate Terraform ProviderOverview