Run actions with Terragrunt

Author: rriveramdz

README.md

@@ -1,93 +1,103 @@
-# Terraform GitHub Actions
+# Terragrunt GitHub Actions
 
-Terraform GitHub Actions allow you to execute Terraform commands within GitHub Actions.
+Terragrunt GitHub Actions allow you to execute Terragrunt commands within GitHub Actions.
 
 The output of the actions can be viewed from the Actions tab in the main repository view. If the actions are executed on a pull request event, a comment may be posted on the pull request.
 
-Terraform GitHub Actions are a single GitHub Action that executes different Terraform subcommands depending on the content of the GitHub Actions YAML file.
+Terragrunt GitHub Actions are a single GitHub Action that executes different Terragrunt subcommands depending on the content of the GitHub Actions YAML file.
 
 ## Success Criteria
 
 An exit code of `0` is considered a successful execution.
 
 ## Usage
 
-The most common workflow is to run `terraform fmt`, `terraform init`, `terraform validate`, `terraform plan`, and `terraform taint` on all of the Terraform files in the root of the repository when a pull request is opened or updated. A comment will be posted to the pull request depending on the output of the Terraform subcommand being executed. This workflow can be configured by adding the following content to the GitHub Actions workflow YAML file.
+The most common workflow is to run `terragrunt fmt`, `terragrunt init`, `terragrunt validate`, `terragrunt plan`, and `terragrunt taint` on all of the Terragrunt files in the root of the repository when a pull request is opened or updated. A comment will be posted to the pull request depending on the output of the Terragrunt subcommand being executed. This workflow can be configured by adding the following content to the GitHub Actions workflow YAML file. Note that this action will use `terragrunt` binary to run all commands. In case of passing a `terraform` subcommand `terragrunt` will forward it to `terraform`.
 
 ```yaml
-name: 'Terraform GitHub Actions'
+name: 'Terragrunt GitHub Actions'
 on:
   - pull_request
 env:
   tf_version: 'latest'
+  tg_version: 'latest'
   tf_working_dir: '.'
 jobs:
-  terraform:
-    name: 'Terraform'
+  terragrunt:
+    name: 'Terragrunt'
     runs-on: ubuntu-latest
     steps:
       - name: 'Checkout'
         uses: actions/checkout@master
-      - name: 'Terraform Format'
-        uses: hashicorp/terraform-github-actions@master
+      - name: 'Terragrunt Format'
+        uses: hashicorp/terragrunt-github-actions@master
         with:
-          tf_actions_version: ${{ env.tf_version }}
-          tf_actions_subcommand: 'fmt'
-          tf_actions_working_dir: ${{ env.tf_working_dir }}
-          tf_actions_comment: true
+          tf_actions_actions_version: ${{ env.tf_version }}
+          tg_actions_actions_version: ${{ env.tg_version }}
+          tf_actions_actions_subcommand: 'fmt'
+          tf_actions_actions_working_dir: ${{ env.tf_working_dir }}
+          tf_actions_actions_comment: true
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-      - name: 'Terraform Init'
-        uses: hashicorp/terraform-github-actions@master
+      - name: 'Terragrunt Init'
+        uses: hashicorp/terragrunt-github-actions@master
         with:
           tf_actions_version: ${{ env.tf_version }}
+          tg_actions_version: ${{ env.tg_version }}
           tf_actions_subcommand: 'init'
           tf_actions_working_dir: ${{ env.tf_working_dir }}
           tf_actions_comment: true
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-      - name: 'Terraform Validate'
-        uses: hashicorp/terraform-github-actions@master
+      - name: 'Terragrunt Validate'
+        uses: hashicorp/terragrunt-github-actions@master
         with:
           tf_actions_version: ${{ env.tf_version }}
+          tg_actions_version: ${{ env.tg_version }}
           tf_actions_subcommand: 'validate'
           tf_actions_working_dir: ${{ env.tf_working_dir }}
           tf_actions_comment: true
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-      - name: 'Terraform Plan'
-        uses: hashicorp/terraform-github-actions@master
+      - name: 'Terragrunt Plan'
+        uses: hashicorp/terragrunt-github-actions@master
         with:
           tf_actions_version: ${{ env.tf_version }}
+          tg_actions_version: ${{ env.tg_version }}
           tf_actions_subcommand: 'plan'
           tf_actions_working_dir: ${{ env.tf_working_dir }}
           tf_actions_comment: true
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 ```
 
-This was a simplified example showing the basic features of these Terraform GitHub Actions. Please refer to the examples within the `examples` directory for other common workflows.
+This was a simplified example showing the basic features of these Terragrunt GitHub Actions. Please refer to the examples within the `examples` directory for other common workflows.
 
 ## Inputs
 
 Inputs configure Terraform GitHub Actions to perform different actions.
 
-* `tf_actions_subcommand` - (Required) The Terraform subcommand to execute. Valid values are `fmt`, `init`, `validate`, `plan`, and `apply`.
-* `tf_actions_version` - (Required) The Terraform version to install and execute. If set to `latest`, the latest stable version will be used.
-* `tf_actions_cli_credentials_hostname` - (Optional) Hostname for the CLI credentials file. Defaults to `app.terraform.io`.
-* `tf_actions_cli_credentials_token` - (Optional) Token for the CLI credentials file.
-* `tf_actions_comment` - (Optional) Whether or not to comment on GitHub pull requests. Defaults to `true`.
-* `tf_actions_working_dir` - (Optional) The working directory to change into before executing Terraform subcommands. Defaults to `.` which means use the root of the GitHub repository.
-* `tf_actions_fmt_write` - (Optional) Whether or not to write `fmt` changes to source files. Defaults to `false`.
+| Input Name                          | Description                                                | Required |
+|:------------------------------------|:-----------------------------------------------------------|:--------:|
+| tf_actions_subcommand               | The Terraform/Terragrunt  subcommand to execute.           | `Yes`    |
+| tf_actions_version                  | The Terraform version to install and execute. If set to `latest`, the latest stable version will be used. | `Yes` |
+| tg_actions_version                  | The Terragrunt version to install and execute. If set to `latest`, the latest stable version will be used. | `Yes` |
+| tf_actions_cli_credentials_hostname | Hostname for the CLI credentials file. Defaults to `app.terraform.io`. | `No` |
+| tf_actions_cli_credentials_token    | Token for the CLI credentials file.                        | `No`     |
+| tf_actions_comment                  | Whether or not to comment on GitHub pull requests. Defaults to `true`. | `No` |
+| tf_actions_working_dir              | The working directory to change into before executing Terragrunt subcommands. Defaults to the root of the GitHub repository. | `No` |
+| tf_actions_fmt_write                | Whether or not to write `fmt` changes to source files. Defaults to `false`. | `No` |
 
 ## Outputs
 
 Outputs are used to pass information to subsequent GitHub Actions steps.
 
-* `tf_actions_output` - The Terraform outputs in (stringified) JSON format.
-* `tf_actions_plan_has_changes` - `'true'` if the Terraform plan contained changes, otherwise `'false'`.
-* `tf_actions_plan_output` - The Terraform plan output.
-* `tf_actions_fmt_written` - Whether or not the Terraform formatting from `fmt` was written to source files.
+| Output Name                 | Description                                                                      |
+|:----------------------------|:---------------------------------------------------------------------------------|
+| tf_actions_output           | The Terragrunt outputs in (stringified) JSON format.                             |
+| tf_actions_plan_has_changes | `'true'` if the Terragrunt plan contained changes, otherwise `'false'`.          |
+| tf_actions_plan_output      | The Terragrunt plan output.                                                      |
+| tf_actions_fmt_written      | Whether or not the Terragrunt formatting from `fmt` was written to source files. |
 
 ## Secrets
 
@@ -112,3 +122,5 @@ The usual [Terraform environment variables](https://www.terraform.io/docs/comman
 * `TF_WORKSPACE`
 
 Other environment variables may be configured to pass data into Terraform. If the data is sensitive, consider using [secrets](#secrets) instead.
+
+**This is a fork of [Terraform Github Actions](https://github.com/hashicorp/terraform-github-actions).**

action.yml

@@ -1,12 +1,12 @@
-name: 'Terraform GitHub Actions'
-description: 'Runs Terraform commands via GitHub Actions.'
-author: 'HashiCorp, Inc. Terraform Team <[email protected]>'
+name: 'Terragrunt GitHub Actions'
+description: 'Runs Terragrunt commands via GitHub Actions.'
+author:  'HashiCorp, Inc. Terraform Team <[email protected]>'
 branding:
-  icon: 'terminal'
+  icon: 'cloud'
   color: 'purple'
 inputs:
   tf_actions_subcommand:
-    description: 'Terraform subcommand to execute.'
+    description: 'Terraform or Terragrunt subcommand to execute.'
     required: true
   tf_actions_version:
     description: 'Terraform version to install.'
@@ -25,20 +25,20 @@ inputs:
     description: 'Whether or not to comment on pull requests.'
     default: true
   tf_actions_working_dir:
-    description: 'Terraform working directory.'
+    description: 'Terragrunt working directory.'
     default: '.'
   tf_actions_fmt_write:
-    description: 'Write Terraform fmt changes to source files.'
+    description: 'Write Terragrunt fmt changes to source files.'
     default: false
 outputs:
   tf_actions_output:
-    description: 'The Terraform outputs in JSON format.'
+    description: 'The Terragrunt outputs in JSON format.'
   tf_actions_plan_has_changes:
-    description: 'Whether or not the Terraform plan contained changes.'
+    description: 'Whether or not the Terragrunt plan contained changes.'
   tf_actions_plan_output:
-    description: 'The Terraform plan output.'
+    description: 'The Terragrunt plan output.'
   tf_actions_fmt_written:
-    description: 'Whether or not the Terraform formatting was written to source files.'
+    description: 'Whether or not the Terragrunt formatting was written to source files.'
 runs:
   using: 'docker'
   image: './Dockerfile'

examples/README.md

@@ -1,3 +1,3 @@
 # Examples
 
-Here are some examples showing common workflows using Terraform GitHub Actions.
+Here are some examples showing common workflows using Terragrunt GitHub Actions.

examples/arguments.md

@@ -4,21 +4,21 @@ Arguments can be passed to each subcommand in two ways.
 
 ## Using Arguments
 
-GitHub Actions supports an `args` attribute that will pass arguments to the Terraform subcommand. Using this `args` attribute will place the arguments at the end of the entire `terraform` command, even after all of the arguments defined in the source code. In this example, the argument `-var="env=dev"` will be appended to the `terraform init` command.
+GitHub Actions supports an `args` attribute that will pass arguments to the Terragrunt subcommand. Using this `args` attribute will place the arguments at the end of the entire `terragrunt` command, even after all of the arguments defined in the source code. In this example, the argument `-var="env=dev"` will be appended to the `terragrunt init` command.
 
 ```yaml
-name: 'Terraform GitHub Actions'
+name: 'Terragrunt GitHub Actions'
 on:
   - pull_request
 jobs:
-  terraform:
-    name: 'Terraform'
+  terragrunt:
+    name: 'Terragrunt'
     runs-on: ubuntu-latest
     steps:
       - name: 'Checkout'
         uses: actions/checkout@master
-      - name: 'Terraform Init'
-        uses: hashicorp/terraform-github-actions@master
+      - name: 'Terragrunt Init'
+        uses: hashicorp/terragrunt-github-actions@master
         with:
           tf_actions_version: 0.12.13
           tf_actions_subcommand: 'init'
@@ -32,21 +32,21 @@ jobs:
 
 ## Using Environment Variables
 
-Terraform supports environment variables named `TF_CLI_ARGS` and `TF_CLI_ARG_name` where `name` is the subcommand that is being executed. Using these environment variables will place the arguments after the subcommand but before any arguments defined in the source code. In this example, the argument `-var="env=dev"` will be appended to the `terraform init` command.
+Terragrunt supports environment variables named `TF_CLI_ARGS` and `TF_CLI_ARG_name` where `name` is the subcommand that is being executed. Using these environment variables will place the arguments after the subcommand but before any arguments defined in the source code. In this example, the argument `-var="env=dev"` will be appended to the `terragrunt init` command.
 
 ```yaml
-name: 'Terraform GitHub Actions'
+name: 'Terragrunt GitHub Actions'
 on:
   - pull_request
 jobs:
-  terraform:
-    name: 'Terraform'
+  terragrunt:
+    name: 'Terragrunt'
     runs-on: ubuntu-latest
     steps:
       - name: 'Checkout'
         uses: actions/checkout@master
-      - name: 'Terraform Init'
-        uses: hashicorp/terraform-github-actions@master
+      - name: 'Terragrunt Init'
+        uses: hashicorp/terragrunt-github-actions@master
         with:
           tf_actions_version: 0.12.13
           tf_actions_subcommand: 'init'

examples/backends.md

@@ -1,22 +1,22 @@
-# Terraform Backends
+# Terragrunt Backends
 
-Terraform GitHub Actions supports initializing a `backend` block using the `-backend-config` option.
+Terragrunt GitHub Actions supports initializing a `backend` block using the `-backend-config` option.
 
 The example below shows how to pass the `token` and `organization` arguments to the `remote` backend block. The `token` argument is passed using GitHub Actions secrets while the organization is hardcoded.
 
 ```yaml
-name: 'Terraform GitHub Actions'
+name: 'Terragrunt GitHub Actions'
 on:
   - pull_request
 jobs:
-  terraform:
-    name: 'Terraform'
+  terragrunt:
+    name: 'Terragrunt'
     runs-on: ubuntu-latest
     steps:
       - name: 'Checkout'
         uses: actions/checkout@master
-      - name: 'Terraform Init'
-        uses: hashicorp/terraform-github-actions@master
+      - name: 'Terragrunt Init'
+        uses: hashicorp/terragrunt-github-actions@master
         with:
           tf_actions_version: 0.12.13
           tf_actions_subcommand: 'init'

examples/credentials-file.md

@@ -1,35 +1,37 @@
-# Terraform CLI Credentials File
+# Terragrunt CLI Credentials File
 
 The Terraform CLI credentials file is used to authenticate to Terraform Cloud/Enterprise. This is useful if the Terraform configuration contains many `terraform_remote_state` data sources that read from the same Terraform Cloud/Enterprise instance or if the configuration uses modules located in the Private Module Registry.
 
 This example shows how to pass the hostname and token needed to create the CLI credentials file.
 
 ```yaml
-name: 'Terraform GitHub Actions'
+name: 'Terragrunt GitHub Actions'
 on:
   - pull_request
 jobs:
   terraform:
-    name: 'Terraform'
+    name: 'Terragrunt'
     runs-on: ubuntu-latest
     steps:
       - name: 'Checkout'
         uses: actions/checkout@master
-      - name: 'Terraform Init'
-        uses: hashicorp/terraform-github-actions@master
+      - name: 'Terragrunt Init'
+        uses: hashicorp/terragrunt-github-actions@master
         with:
           tf_actions_version: 0.12.13
+          tg_actions_version: 'latest'
           tf_actions_subcommand: 'init'
           tf_actions_working_dir: '.'
           tf_actions_comment: true
           tf_actions_cli_credentials_hostname: app.terraform.io 
           tf_actions_cli_credentials_token: ${{ secrets.TF_API_TOKEN }}
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-      - name: 'Terraform Plan'
-        uses: hashicorp/terraform-github-actions@master
+      - name: 'Terragrunt Plan'
+        uses: hashicorp/terragrunt-github-actions@master
         with:
           tf_actions_version: 0.12.13
+          tg_actions_version: 'latest'
           tf_actions_subcommand: 'plan'
           tf_actions_working_dir: '.'
 ```

examples/output.md

@@ -1,14 +1,14 @@
-# Terraform Output
+# Terragrunt Output
 
 If you need the outputs of your Terraform configuration later in your GitHub Actions workflow, you can use the `output` subcommand.
 
 ```yaml
-name: 'Terraform GitHub Actions'
+name: 'Terragrunt GitHub Actions'
 on:
   - push
 jobs:
   terraform:
-    name: 'Terraform'
+    name: 'Terragrunt'
     runs-on: ubuntu-latest
     steps:
       - name: 'Checkout'
@@ -18,6 +18,7 @@ jobs:
         uses: hashicorp/terraform-github-actions@master
         with:
           tf_actions_version: 0.12.13
+          tg_actions_version: 'latest'
           tf_actions_subcommand: 'output'
           tf_actions_working_dir: '.'
       - name: 'Use Terraform Output'

examples/tainting.md

@@ -1,22 +1,23 @@
-# Terraform Tainting
+# Terragrunt Tainting
 
 Resources to taint can be specified using the `args` with option.
 
 ```yaml
-name: 'Terraform GitHub Actions'
+name: 'Terragrunt GitHub Actions'
 on:
   - pull_request
 jobs:
   terraform:
-    name: 'Terraform'
+    name: 'Terragrunt'
     runs-on: ubuntu-latest
     steps:
       - name: 'Checkout'
         uses: actions/checkout@master
-      - name: 'Terraform Init'
+      - name: 'Terragrunt Init'
         uses: hashicorp/terraform-github-actions@master
         with:
           tf_actions_version: 0.12.13
+          tg_actions_version: 'latest'
           tf_actions_subcommand: 'init'
           tf_actions_working_dir: '.'
           tf_actions_comment: true
@@ -27,6 +28,7 @@ jobs:
         uses: hashicorp/terraform-github-actions@master
         with:
           tf_actions_version: 0.12.13
+          tg_actions_version: 'latest'
           tf_actions_subcommand: 'taint'
           tf_actions_working_dir: '.'
           tf_actions_comment: true