borchero/Terraform Plan Comment
Post the output of `terraform plan` to a pull request comment.
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Activelast commit Jul 1, 2026
- License
- MIT
Pinned Snippet
uses: borchero/terraform-plan-comment@2d41e908725447b1677913001dfb92fa7010c025 # v3.1.0tags can be moved; commit SHAs can't. why a SHA?
Inputs
| name | description | required | default |
|---|---|---|---|
| token | The token to use for authenticating against the GitHub API. | yes | — |
| planfile | The path to the planfile whose changes to post. | yes | — |
| terraform-cmd | The command to execute for calling the Terraform binary. | yes | terraform |
| working-directory | The directory where the Terraform binary should be called. | yes | . |
| header | The header to use for the pull request comment. | yes | 📝 Terraform Plan |
| skip-empty | Whether to skip posting a pull request comment when no changes need to be performed. | yes | false |
| skip-comment | Whether to skip posting a pull request comment entirely. | yes | false |
| pr-number | The pull request number to post the comment to. When not provided, the action will attempt to automatically determine the PR number from the event context. This is useful for workflow_dispatch triggers. | no | "" |
| expand-comment | Whether to expand the comment details by default. | yes | false |
Outputs
| name | description |
|---|---|
| markdown | The raw markdown output of the terraform plan |
| empty | Whether the terraform plan contains any change or not |
| change-summary | A human-readable summary of the resource changes |
| num-resources-created | The number of resources to be created |
| num-resources-updated | The number of resources to be updated |
| num-resources-deleted | The number of resources to be deleted |
| num-resources-recreated | The number of resources to be recreated |
| num-resources-ephemeral | The number of ephemeral resources |
| num-resources-imported | The number of resources to be imported |