ci(yamllint): add YAML linting (#733)

Author: Michael Buchar

.github/workflows/ci.yml

@@ -148,6 +148,24 @@ jobs:
       - name: Run Sphinx documentation with doctests
         run: ./run-tests.sh --check-sphinx
 
+  lint-yamllint:
+    runs-on: ubuntu-24.04
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Setup Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Lint YAML files
+        run: |
+          pip install yamllint
+          ./run-tests.sh --check-yamllint
+
   python-tests:
     runs-on: ubuntu-24.04
     steps:

.yamllint.yaml

@@ -0,0 +1,8 @@
+extends: default
+
+rules:
+  comments:
+    min-spaces-from-content: 1
+  document-start: disable
+  line-length: disable
+  truthy: disable

run-tests.sh

@@ -117,6 +117,10 @@ check_jsonlint() {
     find . -name "*.json" -exec jsonlint -q {} \+
 }
 
+check_yamllint() {
+    yamllint .
+}
+
 check_pytest () {
     clean_old_db_container
     start_db_container
@@ -146,6 +150,7 @@ check_all () {
     check_dockerfile
     check_docker_build
     check_jsonlint
+    check_yamllint
 }
 
 if [ $# -eq 0 ]; then
@@ -168,5 +173,6 @@ case $arg in
     --check-dockerfile) check_dockerfile;;
     --check-docker-build) check_docker_build;;
     --check-jsonlint) check_jsonlint ;;
+    --check-yamllint) check_yamllint ;;
     *) echo "[ERROR] Invalid argument '$arg'. Exiting." && exit 1;;
 esac