Skip to content
You're viewing an older version of this GitHub Action. Do you want to see the latest version instead?
terminal

GitHub Action

Setup Terragrunt

v1.0.2

Setup Terragrunt

terminal

Setup Terragrunt

Setup Terragrunt CLI on GitHub Actions runners

Installation

Copy and paste the following snippet into your .yml file.

              

- name: Setup Terragrunt

uses: eLco/[email protected]

Learn more about this action in eLco/setup-terragrunt

Choose a version

setup-terragrunt

setup-terragrunt status

About

The eLco/setup-terragrunt action is a JavaScript action that sets up Terragrunt CLI in your GitHub Actions workflow by:

  • Downloading a specific version of Terragrunt CLI and adding it to the PATH.

After you've used the action, subsequent steps in the same job can run arbitrary Terragrunt commands using the GitHub Actions run syntax. This allows most Terragrunt commands to work exactly like they do on your local command line.

Usage

This action can be run on ubuntu-latest, windows-latest, and macos-latest GitHub Actions runners, and will install and expose a specified version of the terragrunt CLI on the runner environment.

The default configuration installs the latest version of Terragrunt CLI.

Setup the terragrunt CLI, using latest version:

steps:
  - uses: eLco/setup-terragrunt@v1

A specific version of the terragrunt CLI can be installed:

steps:
  - uses: eLco/setup-terragrunt@v1
    with:
      terragrunt_version: 0.35.7

A specific version of the terragrunt CLI can be installed, using personal github token:

steps:
  - uses: eLco/setup-terragrunt@v1
    with:
      terragrunt_version: 0.35.7
      github_token: ${{ secrets.PERSONAL_GITHUB_TOKEN }}

Inputs

The actions supports the following inputs:

  • terragrunt_version: (optional) The version of terragrunt to install, defaulting to latest
  • github_token: (optional) if set, github_token will be used for Octokit authentication. Defaulting to GitHub App installation access token.

License

MIT.