terraform-github-actions

All the terraform actions in this repository are released as one.
Use the actions as part of a GitHub Actions workflow, e.g:

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v2

    - uses: dflook/[email protected]
      with:
        path: my-terraform-config

You can specify an action version as:

• @v1.18.0 to use exactly this release
• @v1.18 to use the latest patch release for this specific minor version
• @v1 to use the latest patch release for this specific major version

Changes

Added

• A new replace input for dflook/terraform-plan and dflook/terraform-apply

  This instructs terraform to replace the specified resources, and is available with terraform versions that support replace (v0.15.2 onwards).

  with:
    replace: |
      random_password.database
  

• A target input for dflook/terraform-plan to match dflook/terraform-apply

  target limits the plan to the specified resources and their dependencies. This change removes the restriction that target can only be used with auto_approve.

  with:
    target: |
      kubernetes_secret.tls_cert_public
      kubernetes_secret.tls_cert_private
  

All the terraform actions in this repository are released as one.
Use the actions as part of a GitHub Actions workflow, e.g:

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v2

    - uses: dflook/[email protected]
      with:
        path: my-terraform-config

You can specify an action version as:

• @v1.17.3 to use exactly this release
• @v1.17 to use the latest patch release for this specific minor version
• @v1 to use the latest patch release for this specific major version

Changes

Fixed

• Compatability with Terraform v1.0.10 - Thanks kylewlacy !
• Now makes even fewer github api requests to avoid rate limiting.

All the terraform actions in this repository are released as one.
Use the actions as part of a GitHub Actions workflow, e.g:

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v2

    - uses: dflook/[email protected]
      with:
        path: my-terraform-config

You can specify an action version as:

• @v1.17.2 to use exactly this release
• @v1.17 to use the latest patch release for this specific minor version
• @v1 to use the latest patch release for this specific major version

Changes

Fixed

• Add terraform plan output that was missing from the workflow log

All the terraform actions in this repository are released as one.
Use the actions as part of a GitHub Actions workflow, e.g:

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v2

    - uses: dflook/[email protected]
      with:
        path: my-terraform-config

You can specify an action version as:

• @v1.17.1 to use exactly this release
• @v1.17 to use the latest patch release for this specific minor version
• @v1 to use the latest patch release for this specific major version

Changes

Fixed

• Fix ownership of files created in runner mounted directories

  As the container is run as root, it can cause issues when root owned files are leftover that the runner can't cleanup.
  This would only affect self-hosted, non-ephemeral, non-root runners.

All the terraform actions in this repository are released as one.
Use the actions as part of a GitHub Actions workflow, e.g:

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v2

    - uses: dflook/[email protected]
      with:
        path: my-terraform-config

You can specify an action version as:

• @v1.17.0 to use exactly this release
• @v1.17 to use the latest patch release for this specific minor version
• @v1 to use the latest patch release for this specific major version

Changes

Added

• variables and var_file support for remote operations in Terraform Cloud/Enterprise.

  The Terraform CLI & Terraform Cloud/Enterprise do not support using variables or variable files with remote plans or applies.
  We can do better. variables and var_file input variables for the plan, apply & check actions now work, with the expected behavior.

All the terraform actions in this repository are released as one.
Use the actions as part of a GitHub Actions workflow, e.g:

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v2

    - uses: dflook/[email protected]
      with:
        path: my-terraform-config

You can specify an action version as:

• @v1.16.0 to use exactly this release
• @v1.16 to use the latest patch release for this specific minor version
• @v1 to use the latest patch release for this specific major version

Changes

Added

• dflook/terraform-plan has gained two new outputs:

  • json_plan_path is a path to the generated plan in a JSON format file
  • text_plan_path is a path to the generated plan in a human readable text file

  These paths are relative to the GitHub Actions workspace and can be read by other steps in the same job.

All the terraform actions in this repository are released as one.
Use the actions as part of a GitHub Actions workflow, e.g:

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v2

    - uses: dflook/[email protected]
      with:
        path: my-terraform-config

You can specify an action version as:

• @v1.15.0 to use exactly this release
• @v1.15 to use the latest patch release for this specific minor version
• @v1 to use the latest patch release for this specific major version

Changes

Added

• Actions that intentionally cause a build failure now set a failure-reason output to enable safely responding to those failures.

  Possible failure reasons are:

  • dflook/terraform-validate: validate-failed
  • dflook/terraform-fmt-check: check-failed
  • dflook/terraform-check: changes-to-apply
  • dflook/terraform-apply: apply-failed, plan-changed
  • dflook/terraform-destroy: destroy-failed
  • dflook/terraform-destroy-workspace: destroy-failed

Fixed

• dflook/terraform-validate was sometimes unable to create detailed check failures.

All the terraform actions in this repository are released as one.
Use the actions as part of a GitHub Actions workflow, e.g:

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v2

    - uses: dflook/[email protected]
      with:
        path: my-terraform-config

You can specify an action version as:

• @v1.14.0 to use exactly this release
• @v1.14 to use the latest patch release for this specific minor version
• @v1 to use the latest patch release for this specific major version

Changes

Added

• Support for self-hosted GitHub Enterprise deployments. Thanks f0rkz!

Changed

• The path input variable is now optional, defaulting to the Action workspace.
• Uninteresting workflow log output is now grouped and collapsed by default.

Fixed

• Applying PR approved plans where the plan comment is not within the first 30 comments.

All the terraform actions in this repository are released as one.
Use the actions as part of a GitHub Actions workflow, e.g:

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v2

    - uses: dflook/[email protected]
      with:
        path: my-terraform-config

You can specify an action version as:

• @v1.13.0 to use exactly this release
• @v1.13 to use the latest patch release for this specific minor version
• @v1 to use the latest patch release for this specific major version

Changes

Added

• TERRAFORM_PRE_RUN environment variable for customising the environment before running terraform.

  It can be set to a command that will be run prior to terraform init.

  The runtime environment for these actions is subject to change in minor version releases.
  If using this environment variable, specify the minor version of the action to use.

  The runtime image is currently based on debian:buster, with the command run using bash -xeo pipefail.

  For example:

  env:
    TERRAFORM_PRE_RUN: |
      # Install latest Azure CLI
      curl -skL https://aka.ms/InstallAzureCLIDeb | bash
  
      # Install postgres client
      apt-get install -y --no-install-recommends postgresql-client
  

All the terraform actions in this repository are released as one.
Use the actions as part of a GitHub Actions workflow, e.g:

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v2

    - uses: dflook/[email protected]
      with:
        path: my-terraform-config

You can specify an action version as:

• @v1.12.0 to use exactly this release
• @v1.12 to use the latest patch release for this specific minor version
• @v1 to use the latest patch release for this specific major version

Changes

Changed

• terraform-fmt-check now shows a diff in the workflow log when it finds files in non-canonical format

All the terraform actions in this repository are released as one.
Use the actions as part of a GitHub Actions workflow, e.g:

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v2

    - uses: dflook/[email protected]
      with:
        path: my-terraform-config

You can specify an action version as:

• @v1.11.0 to use exactly this release
• @v1.11 to use the latest patch release for this specific minor version
• @v1 to use the latest patch release for this specific major version

Changes

Added

• The add_github_comment input for dflook/terraform-plan may now be set to changes-only. This will only add a PR comment
  for plans that result in changes to apply - no comment will be added for plans with no changes.

Changed

• Improved messaging in the workflow log when dflook/terraform-apply is aborted because the plan has changed
• Update documentation for backend_config, backend_config_file, var_file & target inputs to use separate lines for multiple values. Multiple values may still be separated by commas if preferred.

All the terraform actions in this repository are released as one.
Use the actions as part of a GitHub Actions workflow, e.g:

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v2

    - uses: dflook/[email protected]
      with:
        path: my-terraform-config

You can specify an action version as:

• @v1.10.0 to use exactly this release
• @v1.10 to use the latest patch release for this specific minor version
• @v1 to use the latest patch release for this specific major version

Changes

Added

• TERRAFORM_HTTP_CREDENTIALS environment variable for configuring the username and password to use for
  git::https:// & https:// module sources.

  See action documentation for details, e.g. terraform-plan

All the terraform actions in this repository are released as one.
Use the actions as part of a GitHub Actions workflow, e.g:

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v2

    - uses: dflook/[email protected]
      with:
        path: my-terraform-config

You can specify an action version as:

• @v1.9.3 to use exactly this release
• @v1.9 to use the latest patch release for this specific minor version
• @v1 to use the latest patch release for this specific major version

Changes

Fixed

• With terraform 0.15.4, terraform-plan jobs that only had changes to outputs would fail when creating a PR comment.

All the terraform actions in this repository are released as one.
Use the actions as part of a GitHub Actions workflow, e.g:

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v2

    - uses: dflook/[email protected]
      with:
        path: my-terraform-config

You can specify an action version as:

• @v1.9.2 to use exactly this release
• @v1.9 to use the latest patch release for this specific minor version
• @v1 to use the latest patch release for this specific major version

Changes

Fixed

• Slow state locking messages were being considered part of the plan, which could cause apply actions to be aborted.

All the terraform actions in this repository are released as one.
Use the actions as part of a GitHub Actions workflow, e.g:

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v2

    - uses: dflook/[email protected]
      with:
        path: my-terraform-config

You can specify an action version as:

• @v1.9.1 to use exactly this release
• @v1.9 to use the latest patch release for this specific minor version
• @v1 to use the latest patch release for this specific major version

Changes

Fixed

• Terraform 0.15 plans were not being extracted correctly, causing failures to apply.

All the terraform actions in this repository are released as one.
Use the actions as part of a GitHub Actions workflow, e.g:

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v2

    - uses: dflook/[email protected]
      with:
        path: my-terraform-config

You can specify an action version as:

• @v1.9.0 to use exactly this release
• @v1.9 to use the latest patch release for this specific minor version
• @v1 to use the latest patch release for this specific major version

Changes

Added

• variables input for actions that use terraform input variables.

  This value should be valid terraform syntax - like a variable definition file.
  Variable values set in variables override any given in var_files.
  See action documentation for details, e.g. terraform-plan.

Deprecated

• The var input has been deprecated due to the following limitations:

  • Only primitive types can be set with var - number, bool and string.
  • String values may not contain a comma.
  • Values set with var will be overridden by values contained in var_files

  variables is the preferred way to set input variables.

All the terraform actions in this repository are released as one.
Use the actions as part of a GitHub Actions workflow, e.g:

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v2

    - uses: dflook/[email protected]
      with:
        path: my-terraform-config

You can specify an action version as:

• @v1.8.0 to use exactly this release
• @v1.8 to use the latest patch release for this specific minor version
• @v1 to use the latest patch release for this specific major version

Changes

Added

• TERRAFORM_CLOUD_TOKENS environment variable for use with Terraform Cloud/Enterprise etc
  when using module registries or a remote backend.

• TERRAFORM_SSH_KEY environment variable to configure an SSH private key to use for
  Git Repository module sources.

See individual actions for details, e.g. terraform-validate.

All the terraform actions in this repository are released as one.
Use the actions as part of a GitHub Actions workflow, e.g:

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v2

    - uses: dflook/[email protected]
      with:
        path: my-terraform-config

You can specify an action version as:

• @v1.7.0 to use exactly this release
• @v1.7 to use the latest patch release for this specific minor version
• @v1 to use the latest patch release for this specific major version

Changes

Added

• Support for the pull_request_target event
• Support for the pull_request_review event

Fixed

• Terraform 0.15 compatibility

All the terraform actions in this repository are released as one.
Use the actions as part of a GitHub Actions workflow, e.g:

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v2

    - uses: dflook/[email protected]
      with:
        path: my-terraform-config

You can specify an action version as:

• @v1.6.0 to use exactly this release
• @v1.6 to use the latest patch release for this specific minor version
• @v1 to use the latest patch release for this specific major version

Changes

Added

• PR comments use a one line summary of the terraform output, with the full output in a collapsable pane.

  If a plan is short the output is shown by default. This can be controlled with the TF_PLAN_COLLAPSE_LENGTH environment
  variable for the dflook/terraform-plan action.

Fixed

• Now makes far fewer github api requests to avoid rate limiting.

All the terraform actions in this repository are released as one.
Use the actions as part of a GitHub Actions workflow, e.g:

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v2

    - uses: dflook/[email protected]
      with:
        path: my-terraform-config

You can specify an action version as:

• @v1.5.2 to use exactly this release
• @v1.5 to use the latest patch release for this specific minor version
• @v1 to use the latest patch release for this specific major version

Changes

Fixed

• Multiple steps in the same job will now only download the required terraform binary once.