fix(ENG-867): add default version of the action, add new example

README.md

@@ -31,21 +31,23 @@ actions/
 # Example Github Workflow file to run Terraform Check action
 name: Terraform Checks
 
-on: [push, pull_request]
+on: [push] # yamllint disable-line rule:truthy
 
 jobs:
-  example-job:
+  terraform-lint-format:
     runs-on: ubuntu-latest
 
     steps:
       - name: Checkout repository
         uses: actions/checkout@v4
       - name: Run Terraform Action from oak-terraform-actions
-        uses: oaknational/oak-terraform-actions/actions/terraform-checks/action.yml@main
+        uses: oaknational/oak-terraform-actions/actions/terraform-checks@main
 ```
 
 For more details, visit the [Oak Terraform Actions repository](https://github.com/oaknational/oak-terraform-actions).
 
+You can also define the version required if necessary. See the examples folder.
+
 # Commitlint
 
 We're using [husky](https://github.com/typicode/husky) to create pre-commit hooks with commitlint and the [conventional commit plugin](https://github.com/conventional-changelog/commitlint).

actions/terraform-checks/action.yml

@@ -1,6 +1,13 @@
 ---
 name: "Terraform Checks"
 description: "Perform common Terraform checks"
+
+# Can be overriden by the developer when using this action
+inputs:
+  terraform_version:
+    description: "The version of Terraform to use"
+    default: "1.94"
+
 runs:
   using: "composite"
   steps:

examples/pinned-version/terraform-checks-pinned.yml

@@ -0,0 +1,17 @@
+---
+# Example Github Workflow file to run Terraform Check action
+name: Terraform Checks
+
+on: [push, pull_request] # yamllint disable-line rule:truthy
+
+jobs:
+  example-job:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+      - name: Run Terraform Action from oak-terraform-actions
+        uses: oaknational/oak-terrform-actions/actions/terraform-checks@main
+        with:
+          terraform_version: "1.5.7" # Override the default version here