Add yaml format checking with yq

Use yq to verify yaml files instead of relying solely on file format
utilitywarehouse · Oct 4, 2023 · 1817cbe · 1817cbe
1 parent 9dcd585
commit 1817cbe
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 2 deletions.
diff --git a/.github/workflows/pre-commit-hook.yaml b/.github/workflows/pre-commit-hook.yaml
@@ -20,5 +20,7 @@ jobs:
       - name: Install packages
         run: |
           sudo apt-get -y install git
+      - name: Set up yq
+        uses: frenck/action-setup-yq@v1
       - name: Run pre-commit checks script
         run: make hooks-pre-commit-run
diff --git a/scripts/pre-commit b/scripts/pre-commit
@@ -15,7 +15,7 @@ fi
 
 PROM_VERSION="v2.28.1"
 
-function is_yaml() {
+function is_yaml_extension() {
   local file=$1
   if [[ "${file}" == *yaml || "${file}" == *yml || "${file}" == *yaml.tmpl || "${file}" == *yml.tmpl ]]; then
     return 0
@@ -24,12 +24,21 @@ function is_yaml() {
   return 1
 }
 
+function is_valid_yaml() {
+  local file=$1
+  if is_yaml_extension "${file}" && yq -v "${file}" ; then
+    return 0
+  fi
+
+  exit_code=1
+}
+
 # Check alerts
 function check_alerts() {
   local files=$(${GIT_CMD})
   for f in ${files}
   do
-    if is_yaml "${f}"; then
+    if is_valid_yaml "${f}"; then
       if [[ $(head -1 "${f}") =~ "PROMETHEUS RULES" ]]; then
         docker run -i --entrypoint promtool -v $PWD/${f}:$PWD/${f} docker.io/prom/prometheus:${PROM_VERSION} check rules $PWD/${f} &> /dev/null
         if [ $? -ne 0 ]; then