CI: pre-commit check for generated files

.githooks/pre-commit

@@ -0,0 +1,27 @@
+#!/bin/sh
+# This is a simple check to remind people to update the swagger docs
+# if they have made a change to a proto file. It's not iron-clad and non-blocking,
+# but it's better than finding out later in github.
+
+# AMD = added, modified, deleted
+files=$(git diff --cached --name-only --diff-filter=AMD)
+
+LIGHT_RED='\033[1;31m'
+RESET='\033[0m' # No Color
+
+# naive regex check for .proto extension
+if [[ "$files" =~ \.proto ]]
+then
+    # Check if there's a staged diff in /docs
+    result=$(git diff --cached --raw docs/)
+    if [ -n "$result" ]; then
+      # There is a doc update, assume we're ok and exit
+      exit 0
+    else
+      # Don't block, but warn that the docs need updating.
+      echo "This commit contains .proto changes but the docs have not been updated."
+      echo "Your changes were committed, but ${LIGHT_RED}please run 'make all' or this will fail in CI${RESET}\n"
+    fi
+fi
+
+exit 0

Makefile

@@ -1,10 +1,13 @@
 all: patch-swagger-doc format
 
-buf-gen:
+buf-gen: init-hooks
 	./buf.gen.yaml
 
 patch-swagger-doc: buf-gen
 	./scripts/update_swagger.sh docs/openapiv2/apidocs.swagger.json
 
 format: buf-gen
 	buf format -w
+
+init-hooks:
+	git config --local core.hooksPath .githooks/

README.md

@@ -10,7 +10,7 @@ To generate source code from the protobuf definitions contained in this project
 > **Note**: You must have [Buf CLI](https://docs.buf.build/installation) installed to run the following command.
 > 
 ```bash
-./buf.gen.yaml
+make buf-gen
 ```
 
 The command above will generate source code in the `proto/` directory.