Terragrunt in GitHub Actions

Outdated page

This page was set to be reviewed before 2024-01-01 by the page owner.

Contact the page Owner (opens default mail client) if you require this page to be updated

Why

Using terragrunt allows you to really keep all envs the same, and code DRY

How

on: [push]
name: Install terragrunt

jobs:
  deploy:
    runs-on: ubuntu-latest
    name: Deploys Terragrunt
    steps:
      - uses: actions/checkout@v3

      - id: install-tg
        uses: userbradley/actions-install-terragrunt@v1.0.0
        with:
          terragrunt-version: 'v0.47.0'

      - name: Install Terraform
        uses: hashicorp/setup-terraform@v2
        with:
          terraform_version: ${{ env.TF_VERSION }}

      - name: Terragrunt Init
        working-directory: ${{ env.DIR }}
        run: |
          eval `ssh-agent -s`
          ssh-add - <<< '${{ secrets.GH_ACTIONS_SSH_KEY }}'
          terragrunt run-all init -upgrade

I recently created a GitHub action userbradley/actions-install-terragrunt

Full Example

name: Cloudflare Tunnels
env:
  DIR: "dns/tunnels"
  TF_VERSION: 1.4.4
  TERRAGRUNT_VERSION: v0.45.0
on:
  push:
    branches:
      - main
    paths:
      - dns/tunnels/**
      - .github/workflows/cloudflare-tunnels.yaml


jobs:
  terragrunt:
    permissions:
      id-token: write
      contents: read
    env:
      CLOUDFLARE_API_TOKEN: ${{secrets.CLOUDFLARE_API_TOKEN_ZEROTRUST}}

    runs-on: ubuntu-latest
    steps:
      - name: Checkout code
        uses: actions/checkout@v3

      - id: 'auth'
        name: Authenticate to Google Cloud
        uses: 'google-github-actions/auth@v1'
        with:
          workload_identity_provider: ''
          service_account: ''

      - id: install-tg
        uses: userbradley/actions-install-terragrunt@v1.0.0
        with:
          terragrunt-version: 'v0.47.0'

      - name: Install Terraform
        uses: hashicorp/setup-terraform@v2
        with:
          terraform_version: ${{ env.TF_VERSION }}

      - name: Terragrunt Init
        working-directory: ${{ env.DIR }}
        run: |
          eval `ssh-agent -s`
          ssh-add - <<< '${{ secrets.GH_ACTIONS_SSH_KEY }}'
          terragrunt run-all init -upgrade

      - name: Terragrunt Validate
        working-directory: ${{ env.DIR }}
        run: terragrunt run-all validate

      - name: Terragrunt Plan
        working-directory: ${{ env.DIR }}
        run: terragrunt run-all plan

      - name: Terragrunt Apply
        working-directory: ${{ env.DIR }}
        run: terragrunt run-all apply --terragrunt-non-interactive

---

Want to make this site better? Open a PR or help fund hosting costs