How to set up tfcmt in GitHub Actions?

You can integrate tfcmt by adding it as a step in your GitHub Actions workflow YAML, using configuration files to parse Terraform output and post comments. The documentation provides examples for different use cases.

What's the difference between tfcmt and tfnotify?

tfcmt is a fork of tfnotify that adds support for Terraform v0.15 and newer, plus advanced formatting options. It's essentially an enhanced version designed for modern workflows, while tfnotify may lack these updates.

Can tfcmt be used with Terraform Cloud?

tfcmt is primarily for local or CI/CD Terraform runs that output to GitHub PRs. For Terraform Cloud, you might need to adapt the workflow or use alternative notification methods, as it's not directly integrated.

How do I customize the output format in tfcmt?

You can customize formatting through configuration files or command-line options, allowing you to tailor the appearance of plan and apply results, such as adding colors or sections, based on the documented features.

Is tfcmt compatible with older Terraform versions like 0.14?

tfcmt is built for Terraform >= v0.15, so it may not work correctly with older versions. It's recommended to upgrade to supported versions for compatibility and to avoid potential issues.

What are common errors when using tfcmt?

Common errors include misconfigurations in the CI pipeline, incorrect GitHub token permissions, or parsing failures with Terraform output. Check logs and ensure settings match the documentation for troubleshooting.

Open-Awesome

tfcmt

NOASSERTIONGov4.14.17

A Terraform CI/CD tool that posts formatted plan/apply results to GitHub pull requests, forking and enhancing tfnotify.

Visit Website GitHub

538 stars56 forks0 contributors

What is tfcmt?

tfcmt is a command-line tool that integrates with Terraform CI/CD pipelines to automatically post formatted plan and apply results as comments on GitHub pull requests. It solves the problem of unclear or missing feedback in infrastructure changes by providing structured notifications directly in the code review process.

Target Audience

DevOps engineers and platform teams managing Terraform-based infrastructure who use GitHub for collaboration and want to streamline their CI/CD workflows with automated pull request notifications.

Value Proposition

Developers choose tfcmt because it offers better Terraform version compatibility and more flexible formatting than the original tfnotify, making it a reliable and enhanced drop-in replacement for modern Terraform workflows.

Overview

tfcmt enhances mercari/tfnotify in many ways, including Terraform >= v0.15 support and advanced formatting options

Use Cases

Best For

Automating Terraform plan outputs in GitHub pull requests
Enhancing CI/CD pipelines with structured infrastructure change notifications
Teams migrating from tfnotify to a maintained fork with newer Terraform support
Improving collaboration on infrastructure-as-code changes
Customizing the formatting of Terraform CI/CD feedback
Integrating Terraform workflows with GitHub Actions

Not Ideal For

Teams using GitLab or other version control systems, as tfcmt only supports GitHub natively
Projects requiring minimal configuration or zero-setup drop-in solutions
Environments needing real-time notifications outside pull requests, such as Slack or email alerts
Organizations with legacy Terraform versions below v0.15, as tfcmt is optimized for newer releases

Pros & Cons

Pros

Modern Terraform Support

Compatible with Terraform v0.15 and above, addressing a key limitation of the original tfnotify and ensuring it works with current infrastructure workflows.

Advanced Formatting Options

Allows customization of plan and apply output formats in PR comments, enhancing clarity and readability for teams, as highlighted in the README's feature list.

Active Fork with Enhancements

Built on tfnotify with additional improvements and backed by adoption from companies like Recruit Co., Ltd. and ZOZO Inc., indicating reliability and community trust.

GitHub CI/CD Integration

Seamlessly posts notifications to GitHub pull requests, reducing context switching and improving collaboration in CI/CD pipelines, as emphasized in its philosophy.

Cons

Limited Platform Support

Only supports GitHub; for GitLab, users must rely on a separate fork (tfcmt-gitlab), which adds complexity and fragmentation, as noted in the README.

Configuration Complexity

Requires setup for formatting and integration, which may involve manual configuration and not be as straightforward as plug-and-play tools for beginners.

Dependency on Fork Maintenance

As a fork of tfnotify, it inherits potential issues from the original project and might face slower updates or compatibility risks compared to more widely maintained tools.

Frequently Asked Questions

Related Projects

terraformer

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

Stars14,559

Forks1,836

Last commit4 months ago

$Infracost$ Infracost

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

Stars12,413

Forks679

Last commit21 days ago

Terragrunt

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

Stars9,726

Forks1,215

Last commit18 hours ago

atlantis

Terraform Pull Request Automation

Stars9,200

Forks1,304

Last commit1 day ago

Community-curated · Updated weekly · 100% open source

Found a gem we're missing?

Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.

Submit a project Star on GitHub