feat: add plan_only input to support only terraform-plan

Author: h1manshu98

.github/workflows/terraform_workflow.yml

@@ -28,15 +28,15 @@ on:
         required: false
         type: boolean
         default: false
-        description: 'Set true to to destroy terraform infrastructure.'
+        description: 'Set true to destroy terraform infrastructure.'
       approvers:
         required: false
         type: string
         description: 'Approvals list to approve apply or destroy'
       terraform_version:
         type: string
         default: 1.3.6
-        description: 'Required erraform version  '
+        description: 'Required Terraform version'
       timeout:
         required: false
         type: number
@@ -76,6 +76,11 @@ on:
         required: false
         type: string
         default: ""
+      plan_only:
+        description: "Set this to `true` to run `terraform plan` only"
+        required: false
+        type: boolean
+        default: false
     secrets:
       AZURE_CREDENTIALS:
         required: false
@@ -239,6 +244,7 @@ jobs:
           echo "${delimiter}" >> $GITHUB_OUTPUT
 
       - name: "Accept plan or deny"
+        if: ${{ inputs.plan_only != true }}
         uses: trstringer/manual-approval@v1
         timeout-minutes: ${{ inputs.timeout }}
         with:
@@ -248,7 +254,7 @@ jobs:
           issue-title: "Terraform Plan for Infrastructure Update"
 
       - name: terraform apply
-        if: ${{ inputs.destroy != true }}
+        if: ${{ inputs.destroy != true && inputs.plan_only != true }}
         run: |
           if [ -n "${{ inputs.var_file }}" ]; then
            cd ${{ inputs.working_directory }}

docs/terraform-checks.md

@@ -17,9 +17,10 @@ jobs:
   tf-static-checks:
     uses: clouddrove/github-shared-workflows/.github/workflows/tf-checks.yml@master
     with:  
-        working_directory: './_example/complete/'
-        # terraform_version: 0.12.31 // Specify the Terraform version to use. Uncomment and provide your desired version, or leave it as is to use the latest version.
-        aws_credentials: false // Provide your AWS Credentails ID here if 'aws_credentials' is set to 'true'.
+        working_directory: # Specify terraform code directory in repo, eg. './_example/complete/'
+        terraform_version: # Specify terraform version e.g 1.3.6
+        provider:          # aws
+        aws_region:        # specify region eg. us-east-2
     secrets:
       AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
       AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }} 

docs/terraform_workflow.md

@@ -19,12 +19,13 @@ jobs:
     uses: clouddrove/github-shared-workflows/.github/workflows/terraform_workflow.yml@master
     with:
         provider:           # aws
-        working_directory:  # Specify terraform code directory in repo
-        var_file:           # name of tfvar file e.g "variable.tfvar"
+        working_directory:  # Specify terraform code directory in repo, eg. './_example/complete/'
+        var_file:           # name of tfvar file, eg. "variable.tfvar"
         aws_region:         # specify region eg. us-east-2
         approvers:          # Assignee name for approve apply or destroy step
         minimum-approvals:  # Minimum number of approvals required to progress the workflow, deafault value is 1
         terraform_version:  # Specify terraform version e.g 1.3.6
+        plan_only:          # If the value is set to true, the workflow will only show terraform plan
         destroy:            # If the value is set to true, the workflow proceeds to the destroy step. However, the default value is false
      secrets:
         AWS_ACCESS_KEY_ID:  # Specify AWS Access key ID