ci: add a linter for the .yml workflow files (#21459)

.github/.prettierrc

@@ -0,0 +1,3 @@
+{
+  "singleQuote": true
+}

.github/ISSUE_TEMPLATE/documentation.yml

@@ -1,7 +1,7 @@
 name: 📕 Documentation Issue
 description: Report an issue in the Reference documentation or Developer Guide
 title: (short issue description)
-labels: "Unit: Documentation"
+labels: ['Unit: Documentation']
 body:
   - type: textarea
     id: description

.github/dependabot.yml

@@ -1,6 +1,6 @@
 version: 2
 updates:
-  - package-ecosystem: "github-actions"
+  - package-ecosystem: 'github-actions'
-    directory: "/"
+    directory: '/'
     schedule:
-      interval: "daily"
+      interval: 'daily'

.github/workflows/debug.yml

@@ -3,7 +3,6 @@ name: Debug CI
 on: [workflow_dispatch]
 
 jobs:
-
   debug-msvc:
     runs-on: windows-2019
     timeout-minutes: 121

.github/workflows/docs_ci.yml

@@ -7,12 +7,12 @@ name: Docs CI
 on:
   push:
     paths-ignore:
-      - "**.yml"
+      - '**.yml'
-      - "!**/docs_ci.yml"
+      - '!**/docs_ci.yml'
   pull_request:
     paths-ignore:
-      - "**.yml"
+      - '**.yml'
-      - "!**/docs_ci.yml"
+      - '!**/docs_ci.yml'
 
 concurrency:
   group: ${{ github.workflow }}-${{ github.ref == 'refs/heads/master' && github.sha || github.ref }}
@@ -45,7 +45,7 @@ jobs:
         uses: actions/checkout@v4
         with:
           repository: vlang/v
-          ref: master   # important
+          ref: master # important
           path: pv
 
       - name: Check against parent commit

.github/workflows/paths_ci.yml

@@ -3,11 +3,11 @@ name: Path Testing CI
 on:
   push:
     paths-ignore:
-      - "**.md"
+      - '**.md'
       - '!**/paths_ci.yml'
   pull_request:
     paths-ignore:
-      - "**.md"
+      - '**.md'
       - '!**/paths_ci.yml'
 
 concurrency:

.github/workflows/prebuilt.yml

@@ -10,62 +10,62 @@ jobs:
     runs-on: ubuntu-20.04
     timeout-minutes: 5
     steps:
-    - name: Download V
+      - name: Download V
-      run: |
+        run: |
-        wget https://github.com/vlang/v/releases/latest/download/v_linux.zip
+          wget https://github.com/vlang/v/releases/latest/download/v_linux.zip
-        unzip v_linux.zip
+          unzip v_linux.zip
-        cd v
+          cd v
-        ./v -version
+          ./v -version
-    - name: Test V
+      - name: Test V
-      run: |
+        run: |
-        cd v
+          cd v
-        ./v run examples/hello_world.v
+          ./v run examples/hello_world.v
-        ./v -showcc -gc none -cc tcc -no-retry-compilation run examples/hello_world.v
+          ./v -showcc -gc none -cc tcc -no-retry-compilation run examples/hello_world.v
 
   macos-arm64:
     ## macos-14 is a m1 runner
     runs-on: macos-14
     timeout-minutes: 5
     steps:
-    - name: Download V
+      - name: Download V
-      run: |
+        run: |
-        wget https://github.com/vlang/v/releases/latest/download/v_macos_arm64.zip
+          wget https://github.com/vlang/v/releases/latest/download/v_macos_arm64.zip
-        unzip v_macos_arm64.zip
+          unzip v_macos_arm64.zip
-        cd v
+          cd v
-        ./v -version
+          ./v -version
-    - name: Test V
+      - name: Test V
-      run: |
+        run: |
-        cd v
+          cd v
-        ./v run examples/hello_world.v
+          ./v run examples/hello_world.v
-        ./v -showcc -gc none -cc tcc -no-retry-compilation run examples/hello_world.v
+          ./v -showcc -gc none -cc tcc -no-retry-compilation run examples/hello_world.v
 
   macos-x86_64:
     runs-on: macos-latest
     timeout-minutes: 5
     steps:
-    - name: Download V
+      - name: Download V
-      run: |
+        run: |
-        wget https://github.com/vlang/v/releases/latest/download/v_macos_x86_64.zip
+          wget https://github.com/vlang/v/releases/latest/download/v_macos_x86_64.zip
-        unzip v_macos_x86_64.zip
+          unzip v_macos_x86_64.zip
-        cd v
+          cd v
-        ./v -version
+          ./v -version
-    - name: Test V
+      - name: Test V
-      run: |
+        run: |
-        cd v
+          cd v
-        ./v run examples/hello_world.v
+          ./v run examples/hello_world.v
 
   windows:
     runs-on: windows-latest
     timeout-minutes: 5
     steps:
-    - name: Download V
+      - name: Download V
-      run: |
+        run: |
-        curl -L https://github.com/vlang/v/releases/latest/download/v_windows.zip -o v_windows.zip
+          curl -L https://github.com/vlang/v/releases/latest/download/v_windows.zip -o v_windows.zip
-        unzip .\v_windows.zip
+          unzip .\v_windows.zip
-        cd v
+          cd v
-        .\v.exe -version
+          .\v.exe -version
-    - name: Test V
+      - name: Test V
-      run: |
+        run: |
-        cd v
+          cd v
-        .\v.exe run .\examples\hello_world.v
+          .\v.exe run .\examples\hello_world.v
-        .\v.exe -showcc -gc none -cc tcc -no-retry-compilation run .\examples/hello_world.v
+          .\v.exe -showcc -gc none -cc tcc -no-retry-compilation run .\examples/hello_world.v

.github/workflows/sanitized_ci.yml

@@ -147,8 +147,7 @@ jobs:
       - name: Self tests (-fsanitize=address)
         run: ASAN_OPTIONS=detect_leaks=0 ./v -cflags "-fsanitize=address,pointer-compare,pointer-subtract" test-self vlib
       - name: Self tests (V compiled with -fsanitize=address)
-        run:
+        run: ./v -cflags -fsanitize=address -o v cmd/v &&
-          ./v -cflags -fsanitize=address -o v cmd/v &&
           ASAN_OPTIONS=detect_leaks=0 ./v -cc tcc test-self -asan-compiler vlib
       - name: Build examples (V compiled with -fsanitize=address)
         run: ASAN_OPTIONS=detect_leaks=0 ./v build-examples

.github/workflows/vinix_ci.yml

@@ -4,14 +4,14 @@ on:
   workflow_call:
   pull_request:
     paths-ignore:
-      - "**.md"
+      - '**.md'
   push:
     branches:
       - master
     paths-ignore:
-      - "**.md"
+      - '**.md'
-      - "**.yml"
+      - '**.yml'
-      - "!**/vinix_ci.yml"
+      - '!**/vinix_ci.yml'
 
 concurrency:
   group: ${{ github.workflow }}-${{ github.ref == 'refs/heads/master' && github.sha || github.ref }}

.github/workflows/workflow_lint.yml

@@ -0,0 +1,19 @@
+name: Workflow Lint
+
+on:
+  push:
+    paths:
+      - '**.yml'
+  pull_request:
+    paths:
+      - '**.yml'
+
+jobs:
+  format:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Verify formatting
+        uses: creyD/prettier_action@v4.3
+        with:
+          prettier_options: --check .github/**/**.yml