From 270d57ad30a09e71bde85e94904510dfc26649bd Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Marc=20Sch=C3=B6chlin?= <schoechlin@osb-alliance.com>
Date: Sun, 7 Jul 2024 18:38:48 +0200
Subject: [PATCH] Add infrastructure to improve yaml files
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Signed-off-by: Marc Schöchlin <schoechlin@osb-alliance.com>
---
 .github/workflows/yamllint.yaml | 18 ++++++++++++++++++
 .yamlfix.toml                   |  5 +++++
 .yamllint.yml                   | 11 +++++++++++
 Makefile                        | 20 ++++++++++++++++++++
 4 files changed, 54 insertions(+)
 create mode 100644 .github/workflows/yamllint.yaml
 create mode 100644 .yamlfix.toml
 create mode 100644 .yamllint.yml

diff --git a/.github/workflows/yamllint.yaml b/.github/workflows/yamllint.yaml
new file mode 100644
index 00000000..c2869de1
--- /dev/null
+++ b/.github/workflows/yamllint.yaml
@@ -0,0 +1,18 @@
+---
+name: Yamllint
+on: [pull_request]
+jobs:
+  yamllint:
+    name: Yamllint
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@master
+      - name: Yamllint
+        uses: karancode/yamllint-github-action@master
+        with:
+          yamllint_strict: false
+          yamllint_config_filepath: .yamllint.yml
+          yamllint_comment: true
+        env:
+          GITHUB_ACCESS_TOKEN: ${{ secrets.GITHUB_TOKEN }}
diff --git a/.yamlfix.toml b/.yamlfix.toml
new file mode 100644
index 00000000..bd9eb776
--- /dev/null
+++ b/.yamlfix.toml
@@ -0,0 +1,5 @@
+# base.toml
+allow_duplicate_keys = false
+line_length = 100
+preserve_quotes = true
+sequence_style = "block_style"
diff --git a/.yamllint.yml b/.yamllint.yml
new file mode 100644
index 00000000..52d25639
--- /dev/null
+++ b/.yamllint.yml
@@ -0,0 +1,11 @@
+---
+extends: default
+rules:
+  comments: enable
+  line-length: disable
+  empty-lines: disable
+ignore: |-
+  .git
+  .tox
+  secrets.yml
+  secrets-*.yml
diff --git a/Makefile b/Makefile
index 65aad5e8..61380d52 100644
--- a/Makefile
+++ b/Makefile
@@ -1,5 +1,6 @@
 venv = . venv/bin/activate
 export PATH := ${PATH}:${PWD}/venv/bin
+basedir = ${PWD}
 
 VAULTPASS_FILE ?= ${PWD}/secrets/vaultpass
 
@@ -30,6 +31,23 @@ venv/bin/activate: Makefile requirements.txt
 	@${venv} && pip3 install -r requirements.txt
 	touch venv/bin/activate
 
+#################################################
+### EXPERIMENTAL, yamlfix is still very broken
+
+.PHONY: lint-check
+lint-check: deps
+	$(MAKE) lint-fix DO_CHECK="--check"
+
+# Just for testing, currently yamllint seems to be broken
+.PHONY: lint-fix
+lint-fix: deps
+	${venv} && find . -type f \( -not -path "misc/node-images/node-image/*" -and -not -path "*/.venv/*" -and -not -path "*/venv/*" -regex ".*\.ya?ml" \) \
+		-print \
+		-exec yamlfix --verbose ${DO_CHECK} --config-file ${basedir}/.yamlfix.toml {} \;
+
+### EXPERIMENTAL
+#################################################
+
 .PHONY: deps
 sync: deps
 	@[ "${BRANCH}" ] && sed -i -e "s/version: .*/version: ${BRANCH}/" gilt.yml || exit 0
@@ -93,3 +111,5 @@ ifndef FILE
 	$(error FILE variable is not set, example 'make ansible_vault_edit FILE=environments/secrets.yml')
 endif
 	${venv} && ansible-vault edit --vault-password-file ${VAULTPASS_FILE} ${FILE}
+
+