Terraform Branch Deploy

📖 Documentation (GitHub Pages)

📝 Overview

Terraform Branch Deploy extends branch-deploy with first-class support for Terraform infrastructure automation.

⭐ Key Features

• PR-driven automation: Trigger plan and apply by commenting on pull requests.
• Environment targeting: Define environments (dev, staging, prod, etc.) in .tf-branch-deploy.yml with per-environment config, var files, and working directories.
• Safe deployments: Preview every change with a Terraform plan before apply, and support instant rollbacks to a stable branch.
• Environment locking: Prevent concurrent or conflicting deployments with automatic and manual environment locks.
• Custom arguments: Pass extra Terraform CLI arguments from PR comments and fine-tune behavior per environment or globally via .tf-branch-deploy.yml.
• Enterprise ready: Works with GitHub Enterprise Server (GHES) and public GitHub, with automated GHES release tagging.
• Workflow integration: Use the skip input to extract environment context for advanced, multi-step workflows without running Terraform operations.

📸 See It In Action

Watch Terraform Branch Deploy in action - from comment to Terraform infrastructure deployment:

terraform-branch-deploy-demo.mp4

---

📃 License

MIT License - see LICENSE for details.

---

🔗 Quick Links

• Documentation site
• GitHub Discussions
• Report a bug
• Security policy
• Contributing guide
• License