cds-snc/Terraform Plan

Terraform init, validate, format check and plan

View on GitHub

Trust Signals

Scorecard Score
not yet scored
Maintenance Recency
Activelast commit Jul 6, 2026
License
MIT

Pinned Snippet

workflow.ymlSHA-pinned
uses: cds-snc/terraform-plan@529b272050a8f718d14c59e62b59c124eead7efc # v5.0.4

tags can be moved; commit SHAs can't. why a SHA?

namedescriptionrequireddefault
allow-failureAllow the action to failnofalse
commentAdd comment with changes to the PRnotrue
comment-deleteDelete previous comments made by the bot on the PRnofalse
comment-titleThe title to give the PR commentnoPlan changes
conftest-character-limitCharacter limit for Conftest output no2000
conftest-checksLocation of custom conftest check definitions, e.g. `git::https://github.com/user/repository.git`, `./conftest-checks`nogit::https://github.com/cds-snc/opa_checks.git//aws_terraform
directoryDirectory with the *.tf files to validateno.
github-tokenGitHub Token used to add comment to PRnofalse
open-tofuUse OpenTofu instead of Terraformnofalse
plan-character-limitCharacter limit for Terraform plan outputno30000
terraform-initCustom Terraform init argsno""
terraform-planCustom Terraform plan argsno""
terragrunt-planCustom Terragrunt plan argsno""
terragruntUse Terragrunt instead of Terraformnofalse
secret-scanScan Terraform plan with trufflehog for secrets before adding comment to PRnofalse
secret-configPath to TruffleHog config file for secret scanningno""
skip-conftestSkip the conftest stepnofalse
skip-fmtSkip the terraform fmt checknofalse
skip-planSkip the planning step, used for repos that do not specifically have a remote backendnofalse
init-run-allInitialize all terragrunt modules by passing the run --all command to init. Only applicable when using terragruntnofalse
enable-drift-outputEnable generation of the drift-output structured data objectnotrue
namedescription
drift-outputJSON string containing structured summary data about the Terraform run and detected changes