Add a pre-commit for validating zarf schema (#379)

* add pre-commit for validating zarf schema * pre-commit hook to make sure zarf schema is current
zarf-dev · Mar 14, 2022 · 3cef9dc · 3cef9dc
1 parent 5335644
commit 3cef9dc
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 0 deletions.
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -39,3 +39,20 @@ repos:
         language: script
         pass_filenames: false
         description: "Runs `golangci-lint`, requires https://github.com/golangci/golangci-lint"
+  - repo: local
+    hooks:
+      - id: generate-zarf-schema
+        name: Check for outdated Zarf schema
+        entry: hooks/verify-zarf-schema.sh
+        files: "cli/types/types.go"
+        types: [go]
+        language: script
+        description: "Runs `zarf tools config-schema > zarf.schema.json` to ensure schema is up to date"
+  - repo: https://github.com/python-jsonschema/check-jsonschema
+    rev: 0.14.0
+    hooks:
+      - id: check-jsonschema
+        name: "Validate Zarf Configs Against Schema"
+        files: "zarf.yaml"
+        types: [yaml]
+        args: ["--schemafile", "zarf.schema.json"]
diff --git a/hooks/verify-zarf-schema.sh b/hooks/verify-zarf-schema.sh
@@ -0,0 +1,2 @@
+#!/usr/bin/env sh
+go run cli/main.go tools config-schema > zarf.schema.json
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		#!/usr/bin/env sh
		go run cli/main.go tools config-schema > zarf.schema.json