terraform-github-actions

tofu-destroy-workspace action

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

This action uses the tofu destroy command to destroy all resources in an OpenTofu workspace and then delete the workspace.

Inputs

path

The path to the OpenTofu root module directory.
- Type: string
- Optional
- Default: The action workspace
workspace

The name of the OpenTofu workspace to destroy and delete.
- Type: string
- Required
variables

Variables to set for the tofu destroy. This should be valid OpenTofu syntax - like a variable definition file.

Variables set here override any given in var_files.
```
with:
  variables: |
    image_id = "$"
    availability_zone_names = [
      "us-east-1a",
      "us-west-1c",
    ]
```
- Type: string
- Optional
var_file

List of tfvars files to use, one per line. Paths should be relative to the GitHub Actions workspace
```
with:
  var_file: |
    common.tfvars
    prod.tfvars
```
- Type: string
- Optional
backend_config

List of OpenTofu backend config values, one per line.
```
with:
  backend_config: token=$
```
- Type: string
- Optional
backend_config_file

List of OpenTofu backend config files to use, one per line. Paths should be relative to the GitHub Actions workspace
```
with:
  backend_config_file: prod.backend.tfvars
```
- Type: string
- Optional
parallelism

Limit the number of concurrent operations
- Type: number
- Optional
- Default: The OpenTofu default (10).

Outputs

failure-reason

When the job outcome is failure, this output may be set. The value may be one of:
- destroy-failed - The OpenTofu destroy operation failed.
- state-locked - The OpenTofu state lock could not be obtained because it was already locked.
If the job fails for any other reason this will not be set. This can be used with the Actions expression syntax to conditionally run a steps.
- Type: string

lock-info

When the job outcome is failure and the failure-reason is state-locked, this output will be set.

It is a json object containing any available state lock information and typically has the form:

{
  "ID": "838fbfde-c5cd-297f-84a4-d7578b4a4880",
  "Path": "terraform-github-actions/test-unlock-state",
  "Operation": "OperationTypeApply",
  "Who": "root@e9d43b0c6478",
  "Version": "1.3.7",
  "Created": "2023-01-28 00:16:41.560904373 +0000 UTC",
  "Info": ""
}

Type: string

Environment Variables

GITHUB_DOT_COM_TOKEN

This is used to specify a token for GitHub.com when the action is running on a GitHub Enterprise instance. This is only used for downloading OpenTofu binaries from GitHub.com. If this is not set, an unauthenticated request will be made to GitHub.com to download the binary, which may be rate limited.
- Type: string
- Optional
TERRAFORM_CLOUD_TOKENS

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

e.g:
```
env:
  TERRAFORM_CLOUD_TOKENS: app.terraform.io=$
```
With other registries:
```
env:
  TERRAFORM_CLOUD_TOKENS: |
    app.terraform.io=$
    tofu.example.com=$
```
- Type: string
- Optional
TERRAFORM_SSH_KEY

A SSH private key that OpenTofu will use to fetch git/mercurial module sources.

This should be in PEM format.

For example:
```
env:
  TERRAFORM_SSH_KEY: $
```
- Type: string
- Optional
TERRAFORM_HTTP_CREDENTIALS

Credentials that will be used for fetching modules sources with git::http://, git::https://, http:// & https:// schemes.

Credentials have the format <host>=<username>:<password>. Multiple credentials may be specified, one per line.

Each credential is evaluated in order, and the first matching credentials are used.

Credentials that are used by git (git::http://, git::https://) allow a path after the hostname. Paths are ignored by http:// & https:// schemes. For git module sources, a credential matches if each mentioned path segment is an exact match.

For example:
```
env:
  TERRAFORM_HTTP_CREDENTIALS: |
    example.com=dflook:$
    github.com/dflook/terraform-github-actions.git=dflook-actions:$
    github.com/dflook=dflook:$
    github.com=graham:$  
```
- Type: string
- Optional
TERRAFORM_PRE_RUN

A set of commands that will be ran prior to tofu init. This can be used to customise the environment before running OpenTofu.

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:bullseye, 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
```
- Type: string
- Optional

Example usage

This example deletes the workspace named after the git branch when the associated PR is closed.

name: Destroy testing workspace

on:
  pull_request:
    types: [closed]

jobs:
  integration:
    runs-on: ubuntu-latest
    name: Cleanup after integration tests
    steps:
      - name: Checkout
        uses: actions/checkout@v4

      - name: tofu destroy
        uses: dflook/tofu-destroy-workspace@v1
        with:
          path: tofu
          workspace: $

This example retries the tofu destroy operation if it fails.

name: Cleanup

on:
  pull_request:
    types: [closed]

jobs:
  destroy_workspace:
    runs-on: ubuntu-latest
    name: Destroy OpenTofu workspace
    steps:
      - name: Checkout
        uses: actions/checkout@v4

      - name: tofu destroy
        uses: dflook/tofu-destroy-workspace@v1
        id: first_try
        continue-on-error: true
        with:
          path: my-tofu-config
          workspace: $

      - name: Retry failed destroy
        uses: dflook/tofu-destroy-workspace@v1
        if: $
        with:
          path: my-tofu-config
          workspace: $