chore(ci): lint GH action workflows (#49)

Co-authored-by: cos <cos>

4 files changed, 67 insertions, 36 deletions

diff --git a/.github/workflows/.yamllint.yaml b/.github/workflows/.yamllint.yaml
new file mode 100644
index 0000000..2632ac5
--- /dev/null
+++ b/.github/workflows/.yamllint.yaml
@@ -0,0 +1,6 @@
+---
+extends: default
+
+rules:
+  # MSGH Actions has a key called 'on', which causes false positives.
+  truthy: disable
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
index 7ce2825..55a05f5 100644
--- a/.github/workflows/build.yml
+++ b/.github/workflows/build.yml
@@ -1,3 +1,4 @@
+---
 name: "Build"
 
 concurrency:
@@ -13,7 +14,7 @@ on:
   pull_request: {}
   push:
     branches:
-    - master
+      - master
 
 jobs:
   test:
@@ -22,19 +23,19 @@ jobs:
       matrix:
         os: ['ubuntu-20.04', 'macos-13']
         luaVersion:
-        - "5.1"
-        - "5.2"
-        - "5.3"
-        - "5.4"
-        - "luajit"
-        - "luajit-openresty"
+          - "5.1"
+          - "5.2"
+          - "5.3"
+          - "5.4"
+          - "luajit"
+          - "luajit-openresty"
         include:
           - os: "macos-latest"
             luaVersion: "5.4"
           # On Windows builds:
-          # 'hishamhm/gh-actions-lua' will build the PuC Rio Lua versions using MSVC, and
-          # the LuaJIT version using MinGW/gcc. By running against both below, we test
-          # both toolchains.
+          # 'hishamhm/gh-actions-lua' will build the PuC Rio Lua versions using
+          # MSVC, and the LuaJIT version using MinGW/gcc. By running against
+          # both below, we test both toolchains.
           - os: "windows-latest"
             toolchain: "msvc"
             luaVersion: "5.1"
@@ -64,28 +65,31 @@ jobs:
         uses: ilammy/msvc-dev-cmd@v1
 
       # - name: install Dependencies analyzer
-      #   # action step used for troubleshooting if Windows dll's build incorrectly
-      #   run: |
-      #     $version = "1.11.1"
-      #     echo "Installing Dependencies version: $version"
-      #     $url = 'https://github.com/lucasg/Dependencies/releases/download/v' + $version + '/Dependencies_x64_Release.zip'
-      #     $dest = Join-Path -Path $PWD -ChildPath ".dependencies"
+      #   # action step used for troubleshooting if Windows dll's build
+      #   # incorrectly
+      #   run: "
+      #     $version = \"1.11.1\"\n
+      #     echo \"Installing Dependencies version: $version\"\n
+      #     $url = 'https://github.com/lucasg/Dependencies/releases/download/v'
+      #         + $version + '/Dependencies_x64_Release.zip'\n
+      #     $dest = Join-Path -Path $PWD -ChildPath \".dependencies\"\n
 
-      #     # Download and extract Dependencies
-      #     New-Item -ItemType Directory -Path "$dest"
-      #     Invoke-WebRequest -Uri $url -OutFile "$dest\dependencies.zip"
-      #     Expand-Archive -Path "$dest\dependencies.zip" -DestinationPath "$dest"
-      #     Remove-Item -Path "$dest\dependencies.zip"
-      #     # dir "$dest"
+      #     # Download and extract Dependencies\n
+      #     New-Item -ItemType Directory -Path \"$dest\"\n
+      #     Invoke-WebRequest -Uri $url -OutFile \"$dest\\dependencies.zip\"\n
+      #     Expand-Archive -Path \"$dest\\dependencies.zip\" -DestinationPath
+      #         \"$dest\"\n
+      #     Remove-Item -Path \"$dest\\dependencies.zip\"\n
+      #     # dir \"$dest\"\n
 
-      #     # Add Dependencies to PATH
-      #     $env:PATH += ";$dest"
-      #     echo $env:PATH
+      #     # Add Dependencies to PATH\n
+      #     $env:PATH += \";$dest\"\n
+      #     echo $env:PATH\n
 
-      #     # Verify Dependencies Installation
-      #     dir "$dest\*.exe"
-      #     dir ".\.dependencies\Dependencies.exe"
-      #     .\.dependencies\Dependencies.exe -help
+      #     # Verify Dependencies Installation\n
+      #     dir \"$dest\\*.exe\"\n
+      #     dir \".\\.dependencies\Dependencies.exe\"\n
+      #     .\\.dependencies\\Dependencies.exe -help\n
 
       - uses: hishamhm/gh-actions-lua@master
         with:
diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml
index cd31c47..19192f5 100644
--- a/.github/workflows/deploy.yml
+++ b/.github/workflows/deploy.yml
@@ -1,11 +1,13 @@
+---
 name: Deploy
 
-on: [ push, workflow_dispatch ]
+on: [push, workflow_dispatch]
 
 jobs:
 
   affected:
-    uses: lunarmodules/.github/.github/workflows/list_affected_rockspecs.yml@main
+    uses:
+      lunarmodules/.github/.github/workflows/list_affected_rockspecs.yml@main
 
   build:
     needs: affected
@@ -15,16 +17,19 @@ jobs:
       rockspecs: ${{ needs.affected.outputs.rockspecs }}
 
   upload:
-    needs: [ affected, build ]
+    needs: [affected, build]
     # Only run upload if:
     # 1. We are on the canonical repository (no uploads from forks)
-    # 2. The current commit is either tagged or on the default branch (the workflow will upload dev/scm rockspecs any
-    #    time they are touched, tagged ones whenever the edited rockspec and tag match)
-    # 3. Some rockspecs were changed — this implies the commit changing the rockspec is the same one that gets tagged
+    # 2. The current commit is either tagged or on the default branch (the
+    #    workflow will upload dev/scm rockspecs any time they are touched,
+    #    tagged ones whenever the edited rockspec and tag match)
+    # 3. Some rockspecs were changed — this implies the commit changing the
+    #    rockspec is the same one that gets tagged
     if: >-
       ${{
         github.repository == 'lunarmodules/luasystem' &&
-        ( github.ref_name == 'master' || startsWith(github.ref, 'refs/tags/') ) &&
+        ( github.ref_name == 'master' ||
+        startsWith(github.ref, 'refs/tags/') ) &&
         needs.affected.outputs.rockspecs
       }}
     uses: lunarmodules/.github/.github/workflows/upload_to_luarocks.yml@main
diff --git a/.github/workflows/luacheck.yml b/.github/workflows/luacheck.yml
index 9cb784c..b268e4f 100644
--- a/.github/workflows/luacheck.yml
+++ b/.github/workflows/luacheck.yml
@@ -1,3 +1,4 @@
+---
 name: Luacheck
 
 on: [push, pull_request]
@@ -11,3 +12,18 @@ jobs:
         uses: actions/checkout@v4
       - name: Luacheck
         uses: lunarmodules/luacheck@v1
+
+  yamllint:
+    name: Run yamllint
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+      - name: Set up Python
+        uses: actions/setup-python@v5
+      - name: Install yamllint
+        run: pip install yamllint
+      - name: Run yamllint
+        run: |
+          yamllint -c .github/workflows/.yamllint.yaml .