feat: support the option to use -lock=false during Terraform plan (#10

)

README.md

@@ -284,3 +284,42 @@ jobs:
         run: |
           terraform apply -auto-approve
 ```
+
+### Disable locking for `terraform plan`
+
+In some situation, you want to disabling workspace locking when running `terraform plan`.
+
+In your `.github/workflows/terraform.yml` file you would have:
+```yaml
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+    paths:
+      - '**.tf'
+      - '.github/workflows/terraform.yml'
+
+jobs:
+  terraform:
+    name: "Terraform"
+    runs-on: ubuntu-latest
+    env:
+      TF_WORKSPACE: "default"
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      - name: Setup Terraform
+        uses: hashicorp/setup-terraform@v1
+        with:
+          terraform_version: ~1.0.0
+          cli_config_credentials_token: ${{ secrets.TF_TOKEN }}
+
+      - uses: tchupp/actions-terraform-pr@v1
+        with:
+          apply-branch: "main"
+          lock-for-plan: false
+```

action.yml

@@ -20,6 +20,10 @@ inputs:
     description: "Custom title for the PR comment. Defaults to '${TF_WORKSPACE}' if not specified."
     required: false
     default: ""
+  lock-for-plan:
+    description: "Should we use a workspace lock for the `terraform plan`? https://www.terraform.io/language/state/locking"
+    required: false
+    default: true
 runs:
   using: "composite"
   steps:
@@ -73,7 +77,7 @@ runs:
       run: |
         if [[ '${{ github.ref }}' != 'refs/heads/${{ inputs.apply-branch }}' ]]; then
           cd ${{ inputs.path }}
-          if terraform plan -no-color; then
+          if terraform plan -no-color -lock=${{ inputs.lock-for-plan }}; then
             echo "::set-output name=plan-outcome::success"
           else
             echo "::set-output name=plan-outcome::failure"