How to integrate tf-summarize with GitHub Actions?

Use the setup-tf-summarize action or manually install it in your workflow. The README provides examples, including steps to comment plan summaries in pull requests for automated reviews.

tf-summarize vs terraform show -json?

tf-summarize formats the JSON output into readable summaries like tables or trees, while terraform show -json outputs raw JSON. Use tf-summarize for quick insights and terraform show for programmatic access.

How to output tf-summarize as Markdown?

Use the `-md` flag with table view, e.g., `tf-summarize -md tfplan`, to generate Markdown tables. This is useful for documentation or adding formatted summaries to PR comments.

Can tf-summarize handle large Terraform plans?

Yes, it's designed to parse and summarize plans efficiently, but performance may vary with very large datasets. Using JSON input or output formats can help manage complexity.

How to use tf-summarize in Docker without terraform?

Pre-convert the Terraform plan to JSON using `terraform show -json` before passing it to the Docker container, as the image doesn't include Terraform binary, requiring an extra step.

Does tf-summarize work with Terraform Cloud?

It can work with plan outputs from Terraform Cloud if you export them as JSON files, but direct integration isn't built-in; you'll need to handle the plan file manually in your workflow.

Open-Awesome

tf-summarize

MITGov0.3.20

A command-line utility that summarizes Terraform plan output into concise tables, trees, or JSON for quick review.

GitHub

742 stars51 forks0 contributors

What is tf-summarize?

tf-summarize is a command-line utility that parses Terraform plan output and generates a concise summary of resource changes. It helps infrastructure engineers quickly see what resources will be added, changed, or destroyed without reading through lengthy plan logs. The tool supports multiple output formats like tables, trees, JSON, and Markdown for flexible integration into workflows.

Target Audience

Infrastructure engineers, DevOps practitioners, and platform teams who regularly use Terraform for infrastructure provisioning and need to review plan outputs efficiently.

Value Proposition

Developers choose tf-summarize because it dramatically reduces the time spent parsing verbose Terraform plans, provides multiple readable output formats, and integrates seamlessly into CI/CD pipelines. Its ability to work directly with plan files and support for Docker/GitHub Actions makes it a lightweight, versatile addition to any Terraform workflow.

Overview

A command-line utility to print the summary of the terraform plan

Use Cases

Best For

Quickly reviewing Terraform plan changes in CI/CD pipelines
Generating readable summaries for pull request comments
Interactive exploration of infrastructure changes with JSON output
Teams managing large Terraform codebases with frequent plan reviews
Integrating Terraform plan summaries into automated deployment workflows
Visualizing resource change hierarchies with tree output formats

Not Ideal For

Projects requiring detailed, line-by-line audit trails of Terraform changes for compliance
Teams using Terraform Cloud or Enterprise with built-in plan visualization and review tools
Environments where infrastructure changes are rare and verbose plan output is sufficient
Non-CLI workflows where GUI-based plan review tools are preferred

Pros & Cons

Pros

Multiple Output Formats

Supports tables, trees, JSON, HTML, and Markdown outputs, as shown in usage examples like `tf-summarize -tree tfplan` for hierarchical views.

Direct Plan Parsing

Accepts Terraform plan files directly or JSON from `terraform show -json`, eliminating manual parsing, evidenced by commands like `tf-summarize tfplan`.

Flexible Deployment Options

Installable via Go, Homebrew, asdf, Docker, and GitHub Actions, making it adaptable to various environments, as detailed in the install section.

CI/CD Integration

Easily embeddable in GitHub Actions and Codefresh pipelines to comment plan summaries in PRs, with example workflows provided in the README.

Interactive Review Capability

Allows piping JSON output to tools like `fx` for interactive exploration, enhancing the review process with commands like `tf-summarize -json tfplan | fx`.

Cons

Missing Direct Execution

Cannot run Terraform plans directly; requires pre-generated plan or JSON files, as noted in the TODO list with 'Directly run the terraform plan and show the summary' still pending.

Docker Limitation

The Docker image lacks Terraform binary, so it only works with JSON files, not raw plan files, requiring an extra conversion step, as mentioned in the Docker install notes.

Dependency on Third-Party Actions

For optimal GitHub Actions integration, it relies on the external `kishaningithub/setup-tf-summarize` action, which adds a dependency that might not be maintained.

Frequently Asked Questions

Related Projects

terraformer

CLI tool to generate terraform files from existing infrastructure (reverse Terraform). Infrastructure to Code

Stars14,540

Forks1,837

Last commit7 months ago

$Infracost$ Infracost

Cloud cost intelligence for engineers, AI coding agents, and CI/CD 💰📉 Shift FinOps Left!

Stars12,579

Forks701

Last commit2 days ago

Terragrunt

Terragrunt is a flexible orchestration tool that allows Infrastructure as Code written in OpenTofu/Terraform to scale.

Stars9,891

Forks1,244