subhamay-bhattacharyya-gha/Terraform Plan

Run terraform plan with support for S3 backend, HCP Terraform Cloud, and artifact upload.

View on GitHub

Trust Signals

Scorecard Score
not yet scored
Maintenance Recency
Stale
License
None

Inputs

namedescriptionrequireddefault
cloud-providerTarget cloud provider or platform (aws, gcp, azure, snowflake, databricks, platform)yes—
tf-config-pathRelative path from the repository root to the Terraform configuration directory. This is where your main.tf, variables.tf, and other Terraform files are located.notf
release-tagGit release tag to check out. If omitted, the latest commit on the default branch is used.no""
ci-pipelineSet to 'true' to include the commit SHA in the Terraform state key (suitable for CI/CD). Use 'false' for static state keys.nofalse
backend-typeBackend type to use: 's3' for AWS S3 or 'remote' for HCP Terraform Cloud.nos3
s3-bucketName of the S3 bucket used as the backend for storing the Terraform state file. Required when backend-type is 's3'.no—
s3-regionAWS region where the S3 backend bucket is located (e.g., us-east-1, eu-west-1). Required when backend-type is 's3'.no—
s3-key-prefixOptional prefix for the S3 state key (AWS only).no""
tfc-tokenHCP Terraform Cloud API token. Should be passed as a secret. Required when backend-type is 'remote'.no—
aws-regionAWS region for authentication. Required when cloud-provider is 'aws'.no—
aws-role-to-assumeAWS IAM role ARN to assume. Required when cloud-provider is 'aws'.no—
gcp-wif-providerGCP Workload Identity Federation provider. Required when cloud-provider is 'gcp'.no—
gcp-service-accountGCP service account email for authentication. Required when cloud-provider is 'gcp'.no—
azure-client-idAzure client ID for authentication. Required when cloud-provider is 'azure'.no—
azure-tenant-idAzure tenant ID for authentication. Required when cloud-provider is 'azure'.no—
azure-subscription-idAzure subscription ID for authentication. Required when cloud-provider is 'azure'.no—
tf-plan-nameName of the Terraform plan filenoterraform-plan
tf-plan-fileFile to save the Terraform plan outputnotfplan
tf-vars-fileOptional Terraform variable filenoterraform.tfvars
verbose-plan-outputIf true, streams the full terraform plan output to the step log. Default false (summary only).nofalse

Outputs

namedescription
plan-statusResult of terraform plan
plan-binary-pathPath (relative to the caller's working-directory / tf-config-path) to the binary Terraform plan file, e.g. 'tfplan.binary'.
plan-json-pathPath (relative to the caller's working-directory / tf-config-path) to the JSON representation of the Terraform plan, e.g. 'tfplan.json'.
run-urlHCP Terraform run URL (empty for S3 backend).
plan-summaryOne-line summary: 'X to add, Y to change, Z to destroy'.
resources-to-addNumber of resources to be created.
resources-to-changeNumber of resources to be updated.
resources-to-destroyNumber of resources to be destroyed.