Setup Terragrunt GitHub Action

Set up your GitHub Actions workflow with a specific version of Terragrunt. You can optionally set version to latest to use the most recent version.

Because of deprecation in the GitHub Actions environment, versions lower than v1.0.0 will no longer work properly.

Special Notice

From version v3.0.0, the inputs and outputs are changed to dash-separated version (terragrunt-version, terragrunt-version-file, terragrunt-path).

This convention aligns with the YAML style guide and is more prevalent in the GitHub Actions community and documentation.

Usage

The next example step will install Terragrunt 0.55.2.

name: Example workflow

on: [push]

jobs:
  example:
    name: Example Terragrunt interaction
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v2
      - name: Setup Terragrunt
        uses: autero1/action-terragrunt@v3
        with:
          terragrunt-version: 0.55.2
          token: ${{ secrets.GITHUB_TOKEN }}
      - name: Interact with Terragrunt
        run: terragrunt --version

If you want to use a version file, e.g. .terragrunt-version, you can use the following example:

name: Example workflow with version file

on: [push]

jobs:
  example:
    name: Example Terragrunt interaction
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v2
      - name: Setup Terragrunt
        uses: autero1/action-terragrunt@v3
        with:
          terragrunt-version-file: .terragrunt-version
          token: ${{ secrets.GITHUB_TOKEN }}
      - name: Interact with Terragrunt
        run: terragrunt --version

Inputs

Parameter	Description	Required
`terragrunt-version`	Terragrunt version to deploy. Use `latest` for the most recent version.	either version or version file required
`terragrunt-version-file`	File containing the Terragrunt version to install.	either version or version file required
`token`	Github API Token to avoid rate limiting while getting latest Terragrunt release	false

Outputs

Parameter	Description
`terragrunt-path`	Cached tool path of Terragrunt

Supported platforms

This action has been tested on the following platforms:

ubuntu-22.04
windows-latest
macos-latest

Contributing

Contributions to this repository are very welcome! We follow a fairly standard pull request process for contributions, subject to the following guidelines:

File a GitHub issue
Fork the repository
Update the documentation
Update the tests
Update the code
Create a pull request
(Merge and release)

The maintainers for this repo will review your code and provide feedback. If everything looks good, they will merge the code and release a new version, which you'll be able to find in the releases page. Release process is automated using release-please.

License

The scripts and documentation in this project are released under the MIT license.