Ensure the swagger files are fresh (#644)

Signed-off-by: Radoslav Dimitrov <[email protected]>
Co-authored-by: Copilot Autofix powered by AI <62310815+github-advanced-security[bot]@users.noreply.github.com>

Author: rdimitrov

.github/workflows/run-on-main.yml

@@ -16,9 +16,12 @@ jobs:
   e2e-tests:
     name: E2E Tests
     uses: ./.github/workflows/e2e-tests.yml
+  swagger:
+    name: Swagger
+    uses: ./.github/workflows/verify-swagger.yml
   image-build-and-push:
     name: Build and Sign Image
-    needs: [ linting, tests, e2e-tests ]
+    needs: [ linting, tests, e2e-tests, swagger ]
     permissions:
       contents: write
       packages: write

.github/workflows/run-on-pr.yml

@@ -23,6 +23,9 @@ jobs:
   docs:
     name: Docs
     uses: ./.github/workflows/verify-docgen.yml
+  swagger:
+    name: Swagger
+    uses: ./.github/workflows/verify-swagger.yml
   operator-ci:
     name: Operator CI
     permissions:

.github/workflows/verify-swagger.yml

@@ -0,0 +1,36 @@
+name: Swagger
+
+on:
+  workflow_call:
+
+permissions:
+  contents: read
+
+jobs:
+  swagger:
+    name: Verify Swagger
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
+      - uses: actions/setup-go@d35c59abb061a4a6fb18e82ac0862c26744d6ab5 # v5
+        with:
+          go-version-file: go.mod
+      - name: Install Task
+        uses: arduino/setup-task@v2
+        with:
+          version: 3.x
+          repo-token: ${{ secrets.GITHUB_TOKEN }}
+      - name: Install swagger
+        run: task swagger-install
+      - name: Generate swagger files
+        run: task swagger-gen
+      - name: Check for changes
+        run: |
+          if ! git diff --exit-code docs/server/; then
+            echo "❌ Swagger files are not up to date!"
+            echo "Please run 'task swagger-gen' or 'swag init -g pkg/api/server.go --v3.1 -o docs/server' and commit the changes."
+            exit 1
+          else
+            echo "✅ Swagger files are up to date!"
+          fi

Taskfile.yml

@@ -11,6 +11,17 @@ tasks:
     cmds:
       - go run cmd/help/main.go --dir docs/cli
 
+  swagger-install:
+    desc: Install the swag tool for OpenAPI/Swagger generation
+    cmds:
+      - go install github.com/swaggo/swag/v2/cmd/[email protected]
+
+  swagger-gen:
+    desc: Generate OpenAPI/Swagger documentation
+    deps: [swagger-install]
+    cmds:
+      - swag init -g pkg/api/server.go --v3.1 -o docs/server
+
   lint:
     desc: Run linting tools
     cmds: