Skip to content

Latest commit

 

History

History
78 lines (56 loc) · 2.94 KB

README.md

File metadata and controls

78 lines (56 loc) · 2.94 KB

license release GitHub release date Test Action CodeFactor

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.

Usage

The next example step will install Terragrunt 0.21.13.

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/[email protected]
        with:
          terragrunt_version: 0.21.13
          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. true
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-18.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:

  1. File a GitHub issue
  2. Fork the repository
  3. Update the documentation
  4. Update the tests
  5. Update the code
  6. Create a pull request
  7. (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.

License

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