ci: add validation with yamllint (goss-org#951)

* ci: add validation with yamllint

* use makefile

* disable warnings for comments-indentation

* fix configuration for comments-indentation

Author: dklimpel

.github/workflows/docker-goss.yaml

@@ -18,7 +18,7 @@ jobs:
     permissions:
       packages: write
       contents: read
-      security-events: write # To upload Trivy sarif files
+      security-events: write  # To upload Trivy sarif files
 
     steps:
       - name: Checkout

.github/workflows/yamllint.yaml

@@ -0,0 +1,17 @@
+name: Validate YAML
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+    paths:
+      - "**/*.ya?ml"
+
+jobs:
+  validate-yaml:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Validate YAML file
+        run: make lint-yaml

.yamllint

@@ -1,8 +1,27 @@
 ---
 extends: default
 
+ignore:
+  # uses go templates (these are invalid yaml files)
+  - integration-tests/goss/goss-service.yaml
+  - integration-tests/goss/goss-shared.yaml
+  - docs/goss.yaml
+
 rules:
+  braces:
+    min-spaces-inside: 0
+    max-spaces-inside: 1  # required for schema.yaml
+  brackets:
+    min-spaces-inside: 0
+    max-spaces-inside: 1  # required for schema.yaml
+  comments-indentation: disable
+  indentation:
+    spaces: consistent
+    indent-sequences: consistent
   line-length: disable
+  document-start: disable
   truthy:
     allowed-values:
-      - on
+      - "on"  # required for github workflows
+      - "false"
+      - "true"

Makefile

@@ -150,6 +150,11 @@ dcgoss-sha256:
 kgoss-sha256:
 	cd extras/kgoss/ && sha256sum kgoss > kgoss.sha256
 
+.PHONY: lint-yaml
+lint-yaml:
+	$(info INFO: Starting $@)
+	yamllint -c .yamllint .
+
 $(PYTHON):
 	$(info Creating virtualenv in $(VENV))
 	@python -m venv $(VENV)

docs/goss.yaml

@@ -16,7 +16,7 @@ command:
     stdout:
       - go version go1.6 linux/amd64
     stderr: []
-    timeout: 10000 # in milliseconds
+    timeout: 10000  # in milliseconds
     skip: false
 
 dns:
@@ -64,7 +64,7 @@ group:
     gid: 65534
   nobody:
     exists: true
-    
+
 
 http:
   https://www.google.com:
@@ -190,14 +190,14 @@ user:
       home: /var/lib/nfs
       shell: /sbin/nologin
       skip: false
-    
+
     nobody:
       exists: true
       uid:
         lt: 500
       groups:
         consist-of: [nobody]
-    
+
     sshd:
       title: UID must be between 50-100, GID doesn't matter. home is flexible
       meta:
@@ -216,7 +216,3 @@ user:
           - /var/run/sshd
 
 # https://github.com/goss-org/goss/blob/master/README.md#manually-editing-goss-files
-            
-
-
-

docs/myapp_gossfile.yaml

@@ -1,2 +1,2 @@
 # This is a sample file referenced by goss.yaml
-# Used for render test and Json schema validation.
+# Used for render test and Json schema validation.