chore(ci): add swagger docs gen to CI (#167)

.github/actions/setup/action.yaml

@@ -23,6 +23,11 @@ runs:
         brew tap defenseunicorns/tap
         brew install uds@0.14.0
 
+    - name: Install Swagger CLI
+      shell: bash
+      run: |
+        go install github.com/swaggo/swag/cmd/swag@latest
+
     - name: Set up QEMU
       uses: docker/setup-qemu-action@49b3bc8e6bdd4a60e6116a5414239cba5943d3cf # v3.2.0
 

.github/workflows/scan-lint.yaml

@@ -21,7 +21,10 @@ jobs:
         run: go install golang.org/x/tools/cmd/goimports@latest
 
       - name: Install golangci-lint
-        run: uds run setup:golangci --no-progress
+        run: uds run setup:golangci
+
+      - name: Check Swagger Docs
+        run: uds run swagger:test
 
       # build ui so ui/build exists when pre-commit runs
       - name: build-ui
@@ -33,7 +36,7 @@ jobs:
           extra_args: --all-files --verbose # pre-commit run --all-files --verbose
 
       - name: Lint Yaml
-        run: uds run lint:yaml --no-progress
+        run: uds run lint:yaml
 
       - name: Lint UI
-        run: uds run lint:ui --no-progress
+        run: uds run lint:ui

.pre-commit-config.yaml

@@ -1,3 +1,5 @@
+exclude: '^docs/swagger.*\.json$|^docs/swagger.*\.yaml$'
+
 repos:
   ### Global ###
   - repo: https://github.com/pre-commit/pre-commit-hooks

docs/swagger.json

@@ -2608,4 +2608,4 @@
             }
         }
     }
-}
+}

tasks.yaml

@@ -3,6 +3,7 @@ includes:
   - lint: tasks/lint.yaml
   - setup: tasks/setup.yaml
   - build: tasks/build.yaml
+  - swagger: tasks/swagger.yaml
 
 variables:
   - name: REF

tasks/swagger.yaml

@@ -0,0 +1,18 @@
+tasks:
+  - name: generate
+    description: "Generate Swagger docs"
+    actions:
+      - cmd: swag init
+
+  - name: test
+    description: "Ensure no changes to Swagger docs"
+    actions:
+      - task: generate
+      - cmd: |
+          if [ -z "$(git status -s "docs")" ]; then
+              echo "Success!"
+          else
+              echo "Swagger docs changes found, please regenerate docs"
+              git status "docs"
+              exit 1
+          fi