validate the YAML

Author: briandfoy

.github/workflows/validate.yml

@@ -0,0 +1,42 @@
+---
+name: validate YAML files
+
+on:
+    push:
+        branches:
+            - '**'
+            - '!**release**'
+        tags-ignore:
+            # I tag release pushes but those should have already been tested
+            - 'release-*'
+        paths:
+            - '.github/workflows/**.yml'
+    pull_request:
+        branches:
+            - '**'
+        paths:
+            - '.github/workflows/**.yml'
+
+jobs:
+    yaml:
+        runs-on: ubuntu-20.04
+        steps:
+            - uses: actions/checkout@v3
+            - name: 'yamllint on repo workflows'
+              uses: karancode/yamllint-github-action@master
+              with:
+                  yamllint_file_or_dir: '.github/workflows'
+                  yamllint_strict: false
+                  yamllint_comment: true
+                  yamllint_config_filepath: yamllint.config
+              env:
+                  YAMLLINT_CONFIG_FILE: yamllint.config
+            - name: 'yamllint on example workflows'
+              uses: karancode/yamllint-github-action@master
+              with:
+                  yamllint_file_or_dir: './perl-module-*.yml'
+                  yamllint_strict: false
+                  yamllint_comment: true
+                  yamllint_config_filepath: yamllint.config
+              env:
+                  YAMLLINT_CONFIG_FILE: yamllint.config

yamllint.config

@@ -0,0 +1,38 @@
+---
+# https://yamllint.readthedocs.io/en/latest/rules.html
+yaml-files:
+  - '*.yaml'
+  - '*.yml'
+  - '.yamllint'
+
+rules:
+  anchors: enable
+  braces: enable
+  brackets: enable
+  colons: enable
+  commas: enable
+  comments:
+    level: warning
+  comments-indentation:
+    level: warning
+  document-end: disable
+  document-start:
+    level: warning
+  empty-lines: enable
+  empty-values: disable
+  float-values: disable
+  hyphens: enable
+  indentation:
+    spaces: consistent
+    indent-sequences: consistent
+    check-multi-line-strings: false
+  key-duplicates: enable
+  key-ordering: disable
+  line-length: disable
+  new-line-at-end-of-file: enable
+  new-lines: enable
+  octal-values: disable
+  quoted-strings: disable
+  trailing-spaces: enable
+  truthy:
+    level: warning