Merge pull request #169 from CooperUnion/user/jacobkoziej/yaml-sanity

YAML Sanity

.github/dependabot.yml

@@ -1,6 +1,9 @@
+---
+
 version: 2
+
 updates:
-  - package-ecosystem: "pip"
-    directory: "/"
+  - package-ecosystem: pip
+    directory: /
     schedule:
-      interval: "daily"
+      interval: daily

.github/workflows/mdbook-deploy.yml

@@ -2,6 +2,7 @@
 
 name: mdbook-deploy
 
+# yamllint disable-line rule:truthy
 on:
   push:
     branches:

.github/workflows/mdbook.yml

@@ -2,8 +2,9 @@
 
 name: mdbook
 
+# yamllint disable-line rule:truthy
 on:
-  pull_request:
+  pull_request: ~
 
 jobs:
   build:

.github/workflows/node_bl.yml

@@ -1,7 +1,10 @@
+---
+
 name: Build node_bl
 
 # node_bl job triggers disabled for now while bootloader is under rework
 # on: [pull_request, push, workflow_dispatch]
+# yamllint disable-line rule:truthy
 on: workflow_dispatch
 
 jobs:
@@ -41,13 +44,13 @@ jobs:
       - name: Build firmware
         run: . .venv/bin/activate && make dbw/node_bl
 
-      - name: 'Upload CAN network'
+      - name: Upload CAN network
         uses: actions/upload-artifact@v3
         with:
           name: can-dbc
           path: build/can/igvc_can.dbc
 
-      - name: 'Upload firmware binaries'
+      - name: Upload firmware binaries
         uses: actions/upload-artifact@v3
         with:
           name: node_bl-bin

.github/workflows/node_fw.yml

@@ -1,6 +1,12 @@
+---
+
 name: Build node_fw
 
-on: [pull_request, push, workflow_dispatch]
+# yamllint disable-line rule:truthy
+on:
+  - pull_request
+  - push
+  - workflow_dispatch
 
 jobs:
   pre_job:
@@ -17,7 +23,7 @@ jobs:
     needs: pre_job
     if: ${{ needs.pre_job.outputs.should_skip != 'true' }}
 
-    runs-on: ubuntu-22.04
+    runs-on: ubuntu-latest
 
     steps:
       - uses: actions/checkout@v3

.github/workflows/pre-commit.yml

@@ -2,9 +2,10 @@
 
 name: pre-commit
 
+# yamllint disable-line rule:truthy
 on:
-  pull_request:
-  push:
+  pull_request: ~
+  push: ~
 
 jobs:
   pre-commit:

.github/workflows/sync-dev.yml

@@ -1,47 +1,53 @@
+---
+
 name: Sync `master` to `dev`
 
+# yamllint disable-line rule:truthy
 on:
   push:
     branches:
-    - master
+      - master
 
 jobs:
   make-sync-pr:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v3
-    - name: Create source branch
-      run: |
-        git config --global push.autoSetupRemote true
-        git checkout -b 'bot-branches/sync-master-dev-${{ github.sha }}'
-        git push
+      - uses: actions/checkout@v3
+      - name: Create source branch
+        run: |
+          git config --global push.autoSetupRemote true
+          git checkout -b 'bot-branches/sync-master-dev-${{ github.sha }}'
+          git push
 
-    - name: Make PR
-      id: make-pr
-      uses: repo-sync/pull-request@v2
-      with:
-        source_branch: 'bot-branches/sync-master-dev-${{ github.sha }}'
-        destination_branch: dev
-        github_token: ${{ secrets.BOT_PAT_SELFDRIVE }}
-        pr_title: '[SYNC-FIX] Merge out-of-sync changes from \`master\` into \`dev\`:grey_exclamation:'
-        pr_body: |
-          Hello! This PR has been automatically generated because you need to merge out-of-sync changes from \`master\` into \`dev\`.
+      - name: Make PR
+        id: make-pr
+        uses: repo-sync/pull-request@v2
+        with:
+          source_branch: bot-branches/sync-master-dev-${{ github.sha }}
+          destination_branch: dev
+          github_token: ${{ secrets.BOT_PAT_SELFDRIVE }}
+          pr_title: >
+            '[SYNC-FIX] Merge out-of-sync changes from \`master\` into
+            \`dev\`:grey_exclamation:'
+          pr_body: >
+            Hello! This PR has been automatically generated because you need to
+            merge out-of-sync changes from \`master\` into \`dev\`.
 
-          **I will try to merge this PR on my own!**
-        pr_label: 'autosync,URGENT'
-        pr_allow_empty: true
+            **I will try to merge this PR on my own!**
+          pr_label: autosync,URGENT
+          pr_allow_empty: true
 
-    - name: Set automerge
-      if: ${{ steps.make-pr.outputs.pr_number != '' }}
-      uses: peter-evans/enable-pull-request-automerge@v2
-      with:
-        token: ${{ secrets.BOT_PAT_SELFDRIVE }}
-        pull-request-number: ${{ steps.make-pr.outputs.pr_number }}
-        merge-method: merge
+      - name: Set automerge
+        if: ${{ steps.make-pr.outputs.pr_number != '' }}
+        uses: peter-evans/enable-pull-request-automerge@v2
+        with:
+          token: ${{ secrets.BOT_PAT_SELFDRIVE }}
+          pull-request-number: ${{ steps.make-pr.outputs.pr_number }}
+          merge-method: merge
 
-    - name: Approve PR
-      if: ${{ steps.make-pr.outputs.pr_number != '' }}
-      uses: hmarr/auto-approve-action@v2
-      with:
-        github-token: ${{ secrets.GITHUB_TOKEN }} # approve as GH Actions
-        pull-request-number: ${{ steps.make-pr.outputs.pr_number }}
+      - name: Approve PR
+        if: ${{ steps.make-pr.outputs.pr_number != '' }}
+        uses: hmarr/auto-approve-action@v2
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}  # approve as GH Actions
+          pull-request-number: ${{ steps.make-pr.outputs.pr_number }}

.pre-commit-config.yaml

@@ -25,7 +25,9 @@ repos:
     rev: 0.7.17
     hooks:
       - id: mdformat
-        args: [--wrap, '72']
+        args:
+          - --wrap
+          - '72'
         exclude: LICENSE\.md
         additional_dependencies:
           - mdformat-gfm
@@ -34,3 +36,13 @@ repos:
     rev: v0.1.1
     hooks:
       - id: ruff
+
+  - repo: https://github.com/lyz-code/yamlfix/
+    rev: 1.13.0
+    hooks:
+      - id: yamlfix
+
+  - repo: https://github.com/adrienverge/yamllint
+    rev: v1.32.0
+    hooks:
+      - id: yamllint

.yamllint.yml

@@ -0,0 +1,7 @@
+---
+
+extends: default
+
+ignore-from-file:
+  - .gitignore
+  - common/.gitignore