v1.47.0

Author: dflook

README.md

@@ -2,7 +2,7 @@
 
 This is one of a suite of Terraform related actions - find them at [dflook/terraform-github-actions](https://github.com/dflook/terraform-github-actions).
 
-:warning: This action uses the `terraform destroy` command to immediately destroy all resources in a terraform workspace.
+:warning: This action uses the `terraform destroy` command to immediately destroy all resources in a Terraform workspace.
 
 To generate a plan that can be reviewed you can instead use the [dflook/terraform-plan](https://github.com/dflook/terraform-github-actions/tree/main/terraform-plan) 
 and [dflook/terraform-apply](https://github.com/dflook/terraform-github-actions/tree/main/terraform-plan) actions with the `destroy` input set to `true`.
@@ -11,23 +11,25 @@ and [dflook/terraform-apply](https://github.com/dflook/terraform-github-actions/
 
 * `path`
 
-  Path to the Terraform root module
+  The path to the Terraform root module directory.
 
   - Type: string
   - Optional
   - Default: The action workspace
 
 * `workspace`
 
-  Terraform workspace to destroy
+  The name of the Terraform workspace to destroy.
 
   - Type: string
   - Optional
   - Default: `default`
 
 * `variables`
 
-  Variables to set for the terraform destroy. This should be valid Terraform syntax - like a [variable definition file](https://www.terraform.io/docs/language/values/variables.html#variable-definitions-tfvars-files).
+  Variables to set for the terraform destroy. This should be valid Terraform syntax - like a [variable definition file](https://developer.hashicorp.com/terraform/language/values/variables#variable-definitions-tfvars-files).
+
+  Variables set here override any given in `var_file`s.
 
   ```yaml
   with:
@@ -39,16 +41,14 @@ and [dflook/terraform-apply](https://github.com/dflook/terraform-github-actions/
       ]
   ```
 
-  Variables set here override any given in `var_file`s.
-
   - Type: string
   - Optional
 
 * `var_file`
 
   List of tfvars files to use, one per line.
   Paths should be relative to the GitHub Actions workspace
-  
+
   ```yaml
   with:
     var_file: |
@@ -61,7 +61,7 @@ and [dflook/terraform-apply](https://github.com/dflook/terraform-github-actions/
 
 * `backend_config`
 
-  List of terraform backend config values, one per line.
+  List of Terraform backend config values, one per line.
 
   ```yaml
   with:
@@ -90,7 +90,7 @@ and [dflook/terraform-apply](https://github.com/dflook/terraform-github-actions/
 
   - Type: number
   - Optional
-  - Default: The terraform default (10)
+  - Default: The Terraform default (10).
 
 ## Outputs
 
@@ -104,6 +104,8 @@ and [dflook/terraform-apply](https://github.com/dflook/terraform-github-actions/
   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.
@@ -121,6 +123,8 @@ and [dflook/terraform-apply](https://github.com/dflook/terraform-github-actions/
   }
   ```
 
+  - Type: string
+
 ## Environment Variables
 
 * `GITHUB_DOT_COM_TOKEN`
@@ -156,7 +160,7 @@ and [dflook/terraform-apply](https://github.com/dflook/terraform-github-actions/
 
 * `TERRAFORM_SSH_KEY`
 
-  A SSH private key that Terraform will use to fetch git module sources.
+  A SSH private key that Terraform will use to fetch git/mercurial module sources.
 
   This should be in PEM format.
 
@@ -169,28 +173,6 @@ and [dflook/terraform-apply](https://github.com/dflook/terraform-github-actions/
   - Type: string
   - Optional
 
-* `TERRAFORM_PRE_RUN`
-
-  A set of commands that will be ran prior to `terraform init`. This can be used to customise the environment before running Terraform. 
-  
-  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:
-  ```yaml
-  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
-
 * `TERRAFORM_HTTP_CREDENTIALS`
 
   Credentials that will be used for fetching modules sources with `git::http://`, `git::https://`, `http://` & `https://` schemes.
@@ -216,6 +198,28 @@ and [dflook/terraform-apply](https://github.com/dflook/terraform-github-actions/
   - Type: string
   - Optional
 
+* `TERRAFORM_PRE_RUN`
+
+  A set of commands that will be ran prior to `terraform init`. This can be used to customise the environment before running Terraform. 
+
+  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:
+  ```yaml
+  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 destroys the resources in a workspace named after the git branch when the associated PR is closed.

action.yaml

@@ -4,39 +4,80 @@ author: Daniel Flook
 
 inputs:
   path:
-    description: Path to the Terraform configuration
+    description: The path to the Terraform root module directory.
     required: false
-    default: .
+    default: "."
   workspace:
-    description: Name of the Terraform workspace
+    description: The name of the Terraform workspace to destroy.
     required: false
-    default: default
-  backend_config:
-    description: List of backend config values to set, one per line
-    required: false
-    default: ""
-  backend_config_file:
-    description: Path to a backend config file
-    required: false
-    default: ""
+    default: "default"
   variables:
-    description: Variable definitions
+    description: |
+      Variables to set for the terraform destroy. This should be valid Terraform syntax - like a [variable definition file](https://developer.hashicorp.com/terraform/language/values/variables#variable-definitions-tfvars-files).
+
+      Variables set here override any given in `var_file`s.
+    required: false
+  var_file:
+    description: |
+      List of tfvars files to use, one per line.
+      Paths should be relative to the GitHub Actions workspace
     required: false
   var:
-    description: Comma separated list of vars to set, e.g. 'foo=bar'
+    description: |
+      Comma separated list of Terraform vars to set.
+      This is 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_file`s
+      - Does not work with the `remote` backend
+      You can change from `var` to `variables` by putting each variable on a separate line and ensuring each string value is quoted.
     required: false
     deprecationMessage: Use the variables input instead.
-  var_file:
-    description: List of var file paths, one per line
+  backend_config:
+    description: List of Terraform backend config values, one per line.
     required: false
+    default: ""
+  backend_config_file:
+    description: |
+      List of Terraform backend config files to use, one per line.
+      Paths should be relative to the GitHub Actions workspace
+    required: false
+    default: ""
   parallelism:
     description: Limit the number of concurrent operations
     required: false
     default: "0"
 
+outputs:
+  failure-reason:
+    description: |
+      When the job outcome is `failure`, this output may be set. The value may be one of:
+
+      - `destroy-failed` - The Terraform destroy operation failed.
+      - `state-locked` - The Terraform 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.
+  lock-info:
+    description: |
+      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:
+      ```json
+      {
+        "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": ""
+      }
+      ```
+
 runs:
   using: docker
-  image: docker://danielflook/terraform-github-actions@sha256:43139c747c6d59c3f83bda22afaff9e331fc959ae1e12769fe1b872ecbd8cdd4
+  image: docker://danielflook/terraform-github-actions@sha256:7aef5fd3c9c6b005c5fe0a77b3065e5a2eeed4650993041a54c25013761237f7
   entrypoint: /entrypoints/destroy.sh
 
 branding: