Pipelines Execute

This GitHub Action automates running Terragrunt (and eventually other) commands in a secure environment. It is designed to be run in your <company-name>/infrastructure-pipelines repository as part of Gruntwork Pipelines.

Env

• PIPELINES_CLI_VERSION (required): The version of the Gruntwork Pipelines CLI to use.

Inputs

• working_directory (required): The folder path to run the Terragrunt command in.
• with_ssh_enabled (optional): Set to true to enable debugging via SSH using mxschmitt/action-tmate.
• terragrunt_command (required): The Terragrunt command to execute. Default is "plan".
• token (required): The GitHub token used for the Terragrunt action.
• tg_version (required): The Terragrunt version to install. Default is "0.48.1".
• tf_version (required): The Terraform version to install. Default is "1.0.11".
• tg_execution_parallelism_limit (optional): "Maximum number of concurrently executed Terraform modules during Terragrunt execution". Default is 0(no-limit).
• infra_live_repo (required): The name of the infrastructure-live repo to execute in.
• infra_live_directory (required): The name of the directory containing the infrastructure-live repo on disk.
• infra_live_repo_branch (required): The branch of the infrastructure-live repo to execute in.
• gruntwork_config (optional): Contents of the Gruntwork config file in the infrastructure-pipelines repo. NOTE: One of gruntwork_config or gruntwork_config_file MUST be passed in.
• gruntwork_config_file (optional): Absolute path to the Gruntwork config file in the infrastructure-repo. NOTE: One of gruntwork_config or gruntwork_config_file MUST be passed in.

Outputs

• plan: The plan output from the Terragrunt execution.

Usage

name: Run Terragrunt
on: [push]

jobs:
  terragrunt_job:
    runs-on: ubuntu-latest
    steps:
    - name: Checkout repository
      uses: actions/checkout@v2

    - name: Run terragrunt
      id: terragrunt
      uses: gruntwork-io/pipelines-execute@v0.0.1
      env:
        PIPELINES_CLI_VERSION: v0.2.0
      with:
        token: ${{ secrets.GW_GITHUB_TOKEN }}
        tf_version: 1.6.1
        tg_version: 0.48.1
        tf_binary: opentofu
        working_directory: ${{ inputs.working_directory }}
        terragrunt_command: "${{ inputs.terragrunt_command }}"
        infra_live_repo: "acme/infrastructure-live"
        infra_live_directory: "infrastructure-live"
        infra_live_repo_branch: "9fb123d99ddc62cacbf37b7..."
        gruntwork_config: "repo-allow-list:
          - acme/infrastructure-live
          "

This example workflow defines a job that runs Terragrunt with the specified parameters.

Note: The provided workflow example uses the GitHub token (${{ secrets.GITHUB_TOKEN }}) for authentication. Ensure the token has sufficient permissions for your repository.