Skip to content
You're viewing an older version of this GitHub Action. Do you want to see the latest version instead?
search

GitHub Action

Terraform Pull Request Report Generator

v3.0.0

Terraform Pull Request Report Generator

search

Terraform Pull Request Report Generator

Updates Pull Requests with visual diff of Terraform Plan changes

Installation

Copy and paste the following snippet into your .yml file.

              

- name: Terraform Pull Request Report Generator

uses: ahmadnassri/[email protected]

Learn more about this action in ahmadnassri/action-terraform-report

Choose a version

GitHub Action: Terraform Pull Request Report Generator

Updates Pull Requests with visual diff of Terraform Plan changes

license release super linter test semantic

Usage

name: terraform-plan

on:
  pull_request:

jobs:
  terraform-plan:
    runs-on: ubuntu-latest

    steps:
      - uses: actions/checkout@v2
      - uses: hashicorp/setup-terraform@v1
        with:
          terraform_wrapper: false

      - run: terraform init
      - run: terraform plan -lock=false -out terraform.plan

      # generate plain output
      - run: terraform show -no-color terraform.plan > terraform.text

      # generate json output
      - run: terraform show -json terraform.plan > terraform.json

      - uses: ahmadnassri/action-terraform-report@v2
        with:
          # tell the action the plan outputs
          terraform-text: ${{ github.workspace }}/terraform.text
          terraform-json: ${{ github.workspace }}/terraform.json

Note: Ensure terraform_wrapper is set to false to better capture the output into a file (or use your own method)

Inputs

input required default description
terraform-text - path to the file resulting from the output of terraform show /path/to/plan
terraform-json - path to the file resulting from the output of terraform show -json /path/to/plan
github-token github.token The GitHub token used to post comments on pull requests
show-plan true include the terraform plan view in the final output?
show-diff false include the diff view in the final output?

Examples

Pull Request Comment (default)
Pull Request Comment (Plan)
Pull Request Comment (Diff)

Author: Ahmad Nassri • Twitter: @AhmadNassri