ENG-593: Improve linting in Github Action

.github/workflows/yaml-lint.yml

@@ -1,24 +1,25 @@
+---
 name: YAML Syntax Check
 
-on: [push, pull_request]
+on: [push, pull_request] # yamllint disable-line rule:truthy
 
 jobs:
   lint-yaml:
     runs-on: ubuntu-latest
 
     steps:
-      - name: Checkout repository
+      - name: "Checkout repository"
         uses: actions/checkout@v4
 
-      - name: Set up Python
-        uses: actions/setup-python@v2
+      - name: "Set up Python"
+        uses: actions/setup-python@v5
         with:
           python-version: "3.x"
 
-      - name: Install yamllint
+      - name: "Install yamllint"
         run: |
           python -m pip install --upgrade pip
           pip install yamllint
 
-      - name: Run yamllint
+      - name: "Run yamllint"
         run: yamllint .

.yamllint.yml

@@ -0,0 +1,5 @@
+---
+rules:
+  comments:
+    require-starting-space: true
+    min-spaces-from-content: 1 # Changed this to stop a mess between linters from Prettier (vscode) to yamllint - https://github.com/prettier/prettier/pull/10926

actions/terraform-checks/action.yml

@@ -1,7 +1,6 @@
 ---
 name: "Terraform Checks"
 description: "Perform common Terraform checks"
-
 runs:
   using: "composite"
   steps:
@@ -10,17 +9,40 @@ runs:
       with:
         terraform_version: ${{ inputs.terraform_version }}
 
-    - name: "INFO: Ascertain Terraform Version"
+    - name: Cache plugin dir
+      uses: actions/cache@v4
+      with:
+        path: ~/.tflint.d/plugins
+        key: tflint-${{ hashFiles('.tflint.hcl') }}
+
+    - name: "Setup TFLint"
+      uses: terraform-linters/setup-tflint@v4
+      with:
+        tflint_version: v0.52.0
+
+    - name: "Print version of tflint"
+      shell: bash
+      run: tflint --version
+
+    - name: "Init TFLint"
+      shell: bash
+      run: tflint --init
+
+    - name: "Run TFLint"
+      shell: bash
+      run: tflint --chdir infrastructure/ --recursive
+
+    - name: "Ascertain Terraform Version"
       shell: bash
       run: terraform --version
 
-    - name: "INFO: Linting Terraform Files"
+    - name: "Checking Terraform Format of Files"
       shell: bash
       run: |
         cd infrastructure
         terraform fmt -check $(find . -name '*tf')
 
-    - name: "INFO: Validate Terraform Configs"
+    - name: "Validate Terraform Configs"
       shell: bash
       run: |
         cd infrastructure

examples/general-use/terraform-checks.yml

@@ -1,7 +1,8 @@
+---
 # Example Github Workflow file to run Terraform Check action
 name: Terraform Checks
 
-on: [push, pull_request]
+on: [push, pull_request] # yamllint disable-line rule:truthy
 
 jobs:
   example-job: