Add pre-commit hook

Techassi · Techassi · commit 1683d56f7049 · 2023-04-21T10:47:45.000+02:00
diff --git a/.githooks/pre-commit b/.githooks/pre-commit
@@ -0,0 +1,29 @@
+#!/bin/sh
+
+set -eu
+
+if ! cargo xtask gen-man
+then
+  echo "Task 'gen-man' failed"
+  exit 1
+fi
+
+if ! cargo xtask gen-comp
+then
+  echo "Task 'gen-comp' failed"
+  exit 1
+fi
+
+if ! git diff --quiet extra/completions
+then
+  echo "Shell completions changed, please add the changes via \"git add extra/completions/*\""
+  exit 1
+fi
+
+if ! git diff --quiet extra/man
+then
+  echo "Man pages changed, please add the changes via \"git add extra/man/*\""
+  exit 1
+fi
+
+exit 0
diff --git a/README.md b/README.md
@@ -9,4 +9,16 @@ This repository contains the Stackable library, the Stackable CLI tool, and the
 - `stackabled`: API server used by frontends to interact with the data platform. [Link][daemon-readme]
 
 [daemon-readme]: ./bins/stackd/README.md
-[ctl-readme]: ./bins/stackctl/README.md
+[ctl-readme]: ./bins/stackctl/README.md
+
+## Developer Setup
+
+This repository ships custom Git hooks. They are located in the `.githooks` directory. Before you enable them, make sure
+to check out the code they execute. Currently, the `pre-commit` hook runs two tasks: `gen-man` and `gen-comp`. See
+[here][xtasks] what these tasks do. To enable all hooks inside the directory, use the following command:
+
+```shell
+git config --local core.hooksPath .githooks/
+```
+
+[xtasks][./xtask/src/main.rs]
