ci: adds formatting and generated files checks (#180)

Adds a go formatting check to the CI pipeline to ensure code
style consistency. Also, adds a check to validate that generated
files (openapi client, docs, schema) are up-to-date before
allowing a PR to be merged. This prevents merge conflicts and
ensures that the generated code is always current.

Signed-off-by: Kris Coleman <[email protected]>

Author: kriscoleman

.github/workflows/pr-lint.yml

@@ -15,6 +15,26 @@ permissions:
   checks: write
 
 jobs:
+  format-check:
+    name: check formatting
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - uses: actions/setup-go@v5
+        with:
+          go-version-file: 'go.mod'
+      - name: Check Go formatting
+        run: |
+          unformatted=$(go fmt ./...)
+          if [ -n "$unformatted" ]; then
+            echo "::error ::The following files need formatting. Please run 'go fmt ./...' or 'make fmt'"
+            echo "$unformatted"
+            exit 1
+          fi
+          echo "✅ All Go files are properly formatted"
+
   golangci:
     name: lint
     runs-on: ubuntu-latest

.github/workflows/pr-test.yml

@@ -24,8 +24,8 @@ jobs:
       - name: Run tests
         run: go test ./...
 
-  docs-check:
-    name: Validate docs
+  generated-files-check:
+    name: Validate generated files
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
@@ -36,11 +36,44 @@ jobs:
         with:
           go-version-file: 'go.mod'
 
-      - run: make generate-docs
-      - name: Check no diff
+      - name: Generate OpenAPI client
+        run: make generate-api
+      - name: Check OpenAPI client is up-to-date
+        run: |
+          if [ ! -z "$(git status --porcelain internal/api/client/)" ]; then
+            echo "::error ::OpenAPI client generation produced diff. Run 'make generate-api' and commit results."
+            git diff internal/api/client/
+            exit 1
+          fi
+
+      - name: Generate documentation
+        run: make generate-docs
+      - name: Check documentation is up-to-date
+        run: |
+          if [ ! -z "$(git status --porcelain docs/)" ]; then
+            echo "::error ::Documentation generation produced diff. Run 'make generate-docs' and commit results."
+            git diff docs/
+            exit 1
+          fi
+
+      - name: Generate schema
+        run: make generate-schema
+      - name: Check schema is up-to-date
+        run: |
+          if [ ! -z "$(git status --porcelain schema/)" ]; then
+            echo "::error ::Schema generation produced diff. Run 'make generate-schema' and commit results."
+            git diff schema/
+            exit 1
+          fi
+
+      - name: Final check for any uncommitted changes
         run: |
           if [ ! -z "$(git status --porcelain)" ]; then
-            echo "::error file=Makefile::Doc generation produced diff. Run 'make generate-docs' and commit results."
+            echo "::error ::Generation produced uncommitted changes. Please run 'make generate' and commit all changes."
+            echo "Changed files:"
+            git status --porcelain
+            echo ""
+            echo "Diff:"
             git diff
             exit 1
           fi

lefthook.yml

@@ -8,13 +8,32 @@ pre-commit:
       stage_fixed: true
 pre-push:
   commands:
-    generate-docs:
+    check-generated-files:
       run: |
+        echo "Checking all generated files are up-to-date..."
+
+        # Check OpenAPI client
+        make generate-api
+        if ! git diff --quiet internal/api/client/; then
+          echo "❌ OpenAPI client is outdated. Please run 'make generate-api' and commit the changes."
+          exit 1
+        fi
+
+        # Check documentation
         make generate-docs
-        if ! git diff --quiet; then
-          echo "Documentation is outdated. Please run 'make generate-docs' and commit the changes."
+        if ! git diff --quiet docs/; then
+          echo "❌ Documentation is outdated. Please run 'make generate-docs' and commit the changes."
+          exit 1
+        fi
+
+        # Check schema
+        make generate-schema
+        if ! git diff --quiet schema/; then
+          echo "❌ Schema is outdated. Please run 'make generate-schema' and commit the changes."
           exit 1
         fi
+
+        echo "✅ All generated files are up-to-date"
       skip: false
     tests:
       run: make test