Overview
This section provides a complete reference for configuring the Terraform Plan GitHub Action, including all available inputs, outputs, permissions, and validation rules.
What's covered
- Inputs — all six input parameters with detailed explanations and examples
- Outputs — both output values for use in subsequent workflow steps
- Validation — how the action validates input parameters
- Permissions — required GitHub Actions permissions
Quick reference
The action accepts six inputs:
- planfile (required) — path to your Terraform plan file
- terraform-cmd (optional) — command to execute for calling the Terraform binary (defaults to
terraform) - working-directory (optional) — directory where the Terraform binary should be called (defaults to
.) - token (optional) — GitHub token for posting comments (defaults to
github.token) - header (optional) — custom header for the PR comment (useful for multi-environment setups)
- aws-region (optional) — AWS region to display in the comment
And provides two outputs:
- markdown — raw markdown output of the formatted plan
- empty — boolean indicating whether the plan contains changes
For detailed explanations, code examples, and use cases, see the Inputs & Outputs reference.
Usage patterns
Looking for practical examples? Check out:
- Usage Examples — practical examples for reusable workflows and artifact-based workflows
- Install guide — best practices and troubleshooting