feat(ci): GitHub Workflow for Swagger APIs doc checks

1. Check if the latest swagger docs are commited with the PR. 2. Check if the swagger docs are formatted. Signed-off-by: Gaurav Mishra <[email protected]>
fossology · Dec 11, 2023 · 9f7bd70 · 9f7bd70
1 parent 5e81a33
commit 9f7bd70
Showing 1 changed file with 67 additions and 0 deletions.
diff --git a/.github/workflows/api-swagger.yml b/.github/workflows/api-swagger.yml
@@ -0,0 +1,67 @@
+# SPDX-FileCopyrightText: 2023 Siemens AG
+# SPDX-FileContributor: Gaurav Mishra <[email protected]>
+# SPDX-License-Identifier: GPL-2.0-only
+
+name: Swagger API Updated
+
+on:
+  pull_request:
+    branches: [ "main" ]
+  workflow_dispatch:
+
+jobs:
+
+  doc-diff:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v3
+
+    - name: Set up Go
+      uses: actions/setup-go@v4
+      with:
+        go-version: '1.20'
+        check-latest: true
+        cache: true
+
+    - name: Install swag
+      run: |
+        go install github.com/swaggo/swag/cmd/swag@latest
+
+    - name: Build Swagger documents
+      run: |
+        swag init --generalInfo api.go --dir ./pkg/api,./pkg/auth,./pkg/db,./pkg/models,./pkg/utils --output ./swag/docs
+
+    - name: Check doc diff
+      run: |
+        diff swag/docs/docs.go cmd/laas/docs/docs.go > swagger-diff.txt
+        # Check if file swagger-diff.txt is empty
+        if [ -s swagger-diff.txt ]
+        then
+          # If file is not empty, echo a message and exit 1
+          echo "Swagger docs are not up to date. Please run 'swag init' and commit the changes."
+          exit 1
+        fi
+
+  doc-fmt:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Set up Go
+        uses: actions/setup-go@v4
+        with:
+          go-version: '1.20'
+          check-latest: true
+          cache: true
+
+      - name: Install swag
+        run: |
+          go install github.com/swaggo/swag/cmd/swag@latest
+
+      - name: Format Swagger documents
+        run: |
+          swag fmt --generalInfo ./pkg/api/api.go --dir ./pkg/api,./pkg/auth,./pkg/db,./pkg/models,./pkg/utils
+
+      - name: Check file diff
+        run: |
+          git diff --exit-code