terraform-version

terraform-version action

This is one of a suite of terraform related actions - find them at dflook/terraform-github-actions.

This action determines the terraform and provider versions to use for a terraform configuration directory.

The version to use is discovered from the first of:

1. A required_version constraint in the terraform configuration.
2. A tfswitch .tfswitchrc file
3. A tfenv .terraform-version file in path of the terraform configuration.
4. The latest terraform version

The version of terraform and all required providers will be output to the workflow log.

Other terraform actions automatically determine the terraform version in the same way. You only need to run this action if you want to use the outputs yourself.

Inputs

• path

  Path to the terraform configuration to apply

  • Type: string
  • Required

Environment Variables

• TERRAFORM_CLOUD_TOKENS

  API tokens for terraform cloud hosts, of the form <host>=<token>. Multiple tokens may be specified, one per line. These tokens may be used for fetching required modules from the registry.

  e.g for terraform cloud:

  env:
    TERRAFORM_CLOUD_TOKENS: app.terraform.io=${{ secrets.TF_CLOUD_TOKEN }}

  With Terraform Enterprise or other registries:

  env:
    TERRAFORM_CLOUD_TOKENS: |
      app.terraform.io=${{ secrets.TF_CLOUD_TOKEN }}
      terraform.example.com=${{ secrets.TF_REGISTRY_TOKEN }}

  • Type: string
  • Optional

• TERRAFORM_SSH_KEY

  A SSH private key that terraform will use to fetch git module sources.

  This should be in PEM format.

  For example:

  env:
    TERRAFORM_SSH_KEY: ${{ secrets.TERRAFORM_SSH_KEY }}

  • Type: string
  • Optional

Outputs

• terraform

  The terraform version that is used by the terraform configuration

• Provider Versions

  Additional outputs are added with the version of each provider that is used by the terraform configuration. For example, if the random provider is used:

  provider "random" {
    version = "2.2.0"
  }

  A random output will be created with the value 2.2.0.

Example usage

on: [push]

jobs:
  required_version:
    runs-on: ubuntu-latest
    name: Print the required terraform  and provider versions
    steps:
      - name: Checkout
        uses: actions/checkout@v2

      - name: Test terraform-version
        uses: dflook/terraform-version@v1
        id: terraform-version
        with:
          path: my-configuration

      - name: Print the version
        run: echo "The terraform version was ${{ steps.terraform-version.outputs.terraform }}"
        
      - name: Print aws provider version
        run: echo "The aws provider version was ${{ steps.terraform-version.outputs.aws }}"