terraform-validate

Description

The terraform-validate action automates the validation of Terraform configurations by running terraform init followed by terraform validate. It handles backend configuration and variable files, making it easy to validate Terraform code in your CI/CD pipelines.

Features

Automatically runs terraform init before validation
Supports custom working directories
Handles backend configuration variables
Supports tfvars files
Provides detailed validation output
Returns validation status as an output

Inputs

This action has no inputs.

Outputs

Name	Description
`is_valid`	No description provided
`description`	No description provided
`stdout`	No description provided
`stderr`	No description provided

Usage Examples

Basic Validation

steps:
  - name: Checkout code
    uses: CSVD/gh-actions-checkout@v4

  - name: Setup Terraform
    uses: CSVD/gh-actions-setup-terraform@v2
    with:
      terraform_version: '1.7.3'

  - name: Validate Terraform Configuration
    id: validate
    uses: CSVD/terraform-validate@v1
    with:
      working-directory: './terraform'

  - name: Check Validation Result
    if: steps.validate.outputs.is_valid != 'true'
    run: |
      echo "Validation errors found:"
      echo "${{ steps.validate.outputs.stderr }}"
      exit 1

Validation with Backend Config

steps:
  - name: Validate with Backend Config
    id: validate
    uses: CSVD/terraform-validate@v1
    with:
      working-directory: './environments/prod'
      backend-config: |
        region=us-east-1
        bucket=my-terraform-state
        key=prod/terraform.tfstate

  - name: Show Validation Output
    run: |
      echo "Validation stdout:"
      echo "${{ steps.validate.outputs.stdout }}"

Validation with Variables File

steps:
  - name: Validate with Variables
    id: validate
    uses: CSVD/terraform-validate@v1
    with:
      working-directory: './modules/app'
      var-file: './environments/test.tfvars'

Complete Workflow with Tests

name: Terraform Quality Checks

on:
  pull_request:
    paths:
      - '**.tf'
      - '**.tfvars'

jobs:
  validate:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout code
        uses: CSVD/gh-actions-checkout@v4

      - name: Setup Terraform
        uses: CSVD/gh-actions-setup-terraform@v2
        with:
          terraform_version: '1.7.3'

      - name: Validate and Test
        id: validate
        uses: CSVD/terraform-validate@v1
        with:
          working-directory: './terraform'
          var-file: './config/dev.tfvars'

      - name: Process Results
        run: |
          if [[ "${{ steps.validate.outputs.is_valid }}" != "true" ]]; then
            echo "::error::Validation failed"
            echo "${{ steps.validate.outputs.stderr }}"
            exit 1
          fi
          
          if [[ "${{ steps.validate.outputs.tests_passed }}" != "true" ]]; then
            echo "::error::Tests failed"
            echo "${{ steps.validate.outputs.stderr }}"
            exit 1
          fi
          
          echo "All validation and tests passed!"

Requirements

Terraform must be installed in the runner environment (typically using hashicorp/setup-terraform action)
Repository must be checked out before running this action
Appropriate AWS credentials if using remote state in S3 (or similar backend configuration)

CSVD/terraform-validate

About

Topics

Resources

Stars

Watchers

Forks

Releases