ci: test with both tofu and terraform in multi-matrix (#390)

* ci: multi tool tests Signed-off-by: Rishav Dhar <19497993+rdhar@users.noreply.github.com> * docs: amend line breaks Signed-off-by: Rishav Dhar <19497993+rdhar@users.noreply.github.com> * ci: install both TF tools conditionally Signed-off-by: Rishav Dhar <19497993+rdhar@users.noreply.github.com> * drop version v prefix Signed-off-by: Rishav Dhar <19497993+rdhar@users.noreply.github.com> * oopsie Signed-off-by: Rishav Dhar <19497993+rdhar@users.noreply.github.com> * ready for merge Signed-off-by: Rishav Dhar <19497993+rdhar@users.noreply.github.com> --------- Signed-off-by: Rishav Dhar <19497993+rdhar@users.noreply.github.com>
OP5dev · Jan 2, 2025 · b84b14d · b84b14d
1 parent 1e60ee1
commit b84b14d
Show file tree

Hide file tree

Showing 2 changed files with 34 additions and 8 deletions.
diff --git a/.github/workflows/tf_tests.yaml b/.github/workflows/tf_tests.yaml
@@ -19,6 +19,9 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
+        tool:
+          - tofu
+          - terraform
         test:
           - pass_one
           - pass_character_limit
@@ -37,24 +40,33 @@ jobs:
         with:
           persist-credentials: false
 
-      - name: Setup TF
+      - name: Setup Tofu
+        if: matrix.tool == 'tofu'
         uses: opentofu/setup-opentofu@12f4debbf681675350b6cd1f0ff8ecfbda62027b # v1.0.4
         with:
-          tofu_version: 1.8.5
+          tofu_version: v1.8.8
           tofu_wrapper: false
 
+      - name: Setup Terraform
+        if: matrix.tool == 'terraform'
+        uses: hashicorp/setup-terraform@b9cd54a3c349d3f38e8881555d616ced269862dd # v3.1.2
+        with:
+          terraform_version: v1.9.8
+          terraform_wrapper: false
+
       - name: Provision TF
         id: tf
         continue-on-error: true
         uses: ./
         with:
+          working-directory: tests/${{ matrix.test }}
           command: ${{ github.event.pull_request.merged && 'apply' || 'plan' }}
           arg-lock: ${{ github.event.pull_request.merged }}
-          working-directory: tests/${{ matrix.test }}
-          tool: tofu
           format: true
           validate: true
           tag-actor: never
+          comment-pr: ${{ matrix.tool == 'tofu' && 'always' || 'never' }}
+          tool: ${{ matrix.tool }}
 
       - name: Echo TF
         run: |

diff --git a/README.md b/README.md
@@ -32,12 +32,14 @@
     </td>
   </tr>
 </table>
+
 </br>
 
 ### View: [Usage Examples](#usage-examples) · [In/Output Parameters](#parameters) · [Security](#security) · [Changelog](#changelog) · [License](#license)
 
 [![PR comment of plan output with "Diff of changes" section expanded.](/.github/assets/comment.png)](https://raw.githubusercontent.com/op5dev/tf-via-pr/refs/heads/main/.github/assets/comment.png "View full-size image.")
-</br></br>
+
+</br>
 
 ## Usage Examples
 
@@ -77,6 +79,7 @@ jobs:
 >
 > - All supported arguments (e.g., `-backend-config`, `-destroy`, `-parallelism`, etc.) are [listed below](#inputs---arguments).
 > - Environment variables can be passed in for cloud platform authentication (e.g., [configure-aws-credentials](https://github.com/aws-actions/configure-aws-credentials "Configuring AWS credentials for use in GitHub Actions.") for short-lived credentials).
+
 </br>
 
 ### Where to find more examples?
@@ -121,6 +124,7 @@ The following workflows showcase common use cases, while a comprehensive list of
     </td>
   </tr>
 </table>
+
 </br>
 
 ### How does encryption work?
@@ -137,12 +141,14 @@ openssl enc -d -aes-256-ctr -pbkdf2 -salt \
   -pass pass:"<passphrase>"
 <tf.tool> show tf.plan.decrypted
 ```
+
 </br>
 
 For each workflow run, a matrix-friendly job summary with logs is added as a fallback to the PR comment. Below this, you'll find a list of plan file artifacts generated during runtime.</br>
 
 [![Workflow job summary with plan file artifact.](/.github/assets/workflow.png)](https://raw.githubusercontent.com/op5dev/tf-via-pr/refs/heads/main/.github/assets/workflow.png "View full-size image.")
-</br></br>
+
+</br>
 
 ## Parameters
 
@@ -164,8 +170,8 @@ For each workflow run, a matrix-friendly job summary with logs is added as a fal
 | UI       | `tag-actor`         | Tag the workflow triggering actor: `always`, `on-change`, or `never`.<sup>4</sup></br>Default: `always`           |
 | UI       | `hide-args`         | Hide comma-separated list of CLI arguments from the command input.</br>Default: `detailed-exitcode,lock,out,var=` |
 | UI       | `show-args`         | Show comma-separated list of CLI arguments in the command input.</br>Default: `workspace`                         |
-</br>
 
+</br>
 
 1. Both `command: plan` and `command: apply` include: `init`, `fmt` (with `format: true`), `validate` (with `validate: true`), and `workspace` (with `arg-workspace`) commands rolled into it automatically.</br>
   To separately run checks and/or generate outputs only, `command: init` can be used.</br></br>
@@ -174,7 +180,8 @@ For each workflow run, a matrix-friendly job summary with logs is added as a fal
 1. The `on-change` option is true when the exit code of the last TF command is non-zero.</br></br>
 1. The default behavior of `comment-method` is to update the existing PR comment with the latest plan/apply output, making it easy to track changes over time through the comment's revision history.</br></br>
   [![PR comment revision history comparing plan and apply outputs.](/.github/assets/revisions.png)](https://raw.githubusercontent.com/op5dev/tf-via-pr/refs/heads/main/.github/assets/revisions.png "View full-size image.")
-</br></br>
+
+</br>
 
 ### Inputs - Arguments
 
@@ -184,6 +191,7 @@ For each workflow run, a matrix-friendly job summary with logs is added as a fal
 > - For repeated arguments like `arg-var`, `arg-backend-config`, `arg-replace` and `arg-target`, use commas to separate multiple values (e.g., `arg-var: key1=value1,key2=value2`).
 
 <details><summary>Toggle view of all available CLI arguments.</summary>
+
 </br>
 
 | Name                      | CLI Argument                             |
@@ -227,6 +235,7 @@ For each workflow run, a matrix-friendly job summary with logs is added as a fal
 | `arg-workspace`           | `-workspace`                             |
 | `arg-write`               | `-write`                                 |
 </details>
+
 </br>
 
 ### Outputs
@@ -245,6 +254,7 @@ For each workflow run, a matrix-friendly job summary with logs is added as a fal
 | Workflow | `job-id`     | ID of the workflow job.                       |
 | Workflow | `run-url`    | URL of the workflow run.                      |
 | Workflow | `identifier` | Unique name of the workflow run and artifact. |
+
 </br>
 
 ## Security
@@ -254,6 +264,7 @@ View [security policy and reporting instructions](SECURITY.md).
 > [!TIP]
 >
 > Pin your workflow version to a specific release tag or SHA to harden your CI/CD pipeline security against supply chain attacks.
+
 </br>
 
 ## Changelog
@@ -268,19 +279,22 @@ View [all notable changes](https://github.com/op5dev/tf-via-pr/releases "Release
 > - [Raise an issue](https://github.com/op5dev/tf-via-pr/issues "Raise an issue.") to propose changes or report unexpected behavior.
 > - [Open a discussion](https://github.com/op5dev/tf-via-pr/discussions "Open a discussion.") to discuss broader topics or questions.
 > - [Become a stargazer](https://github.com/op5dev/tf-via-pr/stargazers "Become a stargazer.") if you find this project useful.
+
 </br>
 
 ### To-Do
 
 - Handling of inputs which contain space(s) (e.g., `working-directory: path to/directory`).
 - Handling of comma-separated inputs which contain comma(s) (e.g., `arg-var: token=1,2,3`)—use `TF_CLI_ARGS` [workaround](https://developer.hashicorp.com/terraform/cli/config/environment-variables#tf_cli_args-and-tf_cli_args_name).
+
 </br>
 
 ## License
 
 - This project is licensed under the permissive [Apache License 2.0](LICENSE "Apache License 2.0.").
 - All works herein are my own, shared of my own volition, and [contributors](https://github.com/op5dev/tf-via-pr/graphs/contributors "Contributors.").
 - Copyright 2016-2024 [Rishav Dhar](https://github.com/rdhar "Rishav Dhar's GitHub profile.") — All wrongs reserved.
+
 </br>
 
 ### Sponsors