clean(GH-881): Add Schema Diagram Generation to Github Pages (#885)

* feat(GH-881): add schema class diagram generation to pages * feat(GH-881): add schema class diagram generation to pages * feat(GH-881): add schema class diagram generation to pages * feat(GH-881): add schema class diagram generation to pages * feat(GH-881): add schema class diagram generation to pages * feat(GH-881): add schema class diagram generation to pages * fix(GH-881): debug add schema class diagram generation to pages * fix(GH-881): debug add schema class diagram generation to pages * fix(GH-881): debug add schema class diagram generation to pages empty classes * fix(GH-881): debug add schema class diagram generation to pages empty classes * fix(GH-881): debug add schema class diagram generation to pages empty classes * fix(GH-881): debug add schema class diagram generation to pages empty classes * fix(GH-881): debug add schema class diagram generation to pages empty classes * fix(GH-881): debug add schema class diagram generation to pages empty classes * fix(GH-881): debug add schema class diagram generation to pages empty classes * fix(GH-881): debug add schema class diagram generation to pages empty classes * fix(GH-881): debug add schema class diagram generation to pages empty classes * fix(GH-881): debug add schema class diagram generation to pages empty classes * fix(GH-881): debug add schema class diagram generation to pages empty classes * fix(GH-881): debug add schema class diagram generation to pages empty classes * fix(GH-881): debug add schema class diagram generation to pages empty classes * fix(GH-881): debug add schema class diagram generation to pages empty classes * fix(GH-881): debug add schema class diagram generation to pages empty classes * fix(GH-881): debug add schema class diagram generation to pages empty classes * fix(GH-881): debug add schema class diagram generation to pages empty classes * fix(GH-881): debug add schema class diagram generation to pages empty classes * fix(GH-881): debug add schema class diagram generation to pages empty classes * fix(GH-881): debug add schema class diagram generation to pages empty classes * fix(GH-881): debug add schema class diagram generation to pages empty classes * fix(GH-881): debug add schema class diagram generation to pages empty classes * clean(GH-881): refactor add schema class diagram generation to pages * clean(GH-881): refactor add schema class diagram generation to pages * clean(GH-881): refactor add schema class diagram generation to pages * clean(GH-881): refactor add schema class diagram generation to pages * clean(GH-881): refactor add schema class diagram generation to pages * clean(GH-881): refactor add schema class diagram generation to pages * clean(GH-881): refactor add schema class diagram generation to pages * clean(GH-881): refactor add schema class diagram generation to pages * clean(GH-881): refactor add schema class diagram generation to pages * clean(GH-881): refactor add schema class diagram generation to pages * clean(GH-881): refactor add schema class diagram generation to pages * clean(GH-881): refactor add schema class diagram generation to pages * clean(GH-881): refactor add schema class diagram generation to pages * clean(GH-881): only on next branch * clean(GH-881): add retention period --------- Co-authored-by: Thomas Fink <[email protected]>
it-at-m · Feb 16, 2025 · bea2a98 · bea2a98
1 parent 3fb8849
commit bea2a98
Show file tree

Hide file tree

Showing 3 changed files with 449 additions and 8 deletions.
diff --git a/.github/workflows/combined-workflow-with-docs.yaml b/.github/workflows/combined-workflow-with-docs.yaml
@@ -80,11 +80,15 @@ jobs:
   call-build-api-docs:
     uses: ./.github/workflows/build-api-docs.yaml
 
+  generate-schema-diagrams:
+    uses: ./.github/workflows/generate-schema-diagrams.yaml
+
   deploy-to-pages:
-    needs: [aggregate-reports, call-build-api-docs]
+    needs: [aggregate-reports, call-build-api-docs, generate-schema-diagrams]
     if: |
       needs.call-build-api-docs.result == 'success' &&
-      needs.aggregate-reports.result == 'success'
+      needs.aggregate-reports.result == 'success' &&
+      needs.generate-schema-diagrams.result == 'success'
     uses: ./.github/workflows/deploy-pages.yaml
     with:
       coverage_artifact: aggregated-reports

diff --git a/.github/workflows/deploy-pages.yaml b/.github/workflows/deploy-pages.yaml
@@ -22,6 +22,7 @@ on:
 permissions:
   pages: write
   id-token: write
+  contents: read
 
 concurrency:
   group: "pages"
@@ -37,6 +38,12 @@ jobs:
       - name: Create public directory
         run: mkdir -p public
 
+      - name: Download schema diagrams
+        uses: actions/download-artifact@v4
+        with:
+          name: schema-diagrams
+          path: public/diagrams
+
       - name: Download coverage reports
         uses: actions/download-artifact@v4
         with:
@@ -55,11 +62,6 @@ jobs:
           name: ${{ inputs.security_artifact }}
           path: public
 
-      - name: Debug - List directory structure
-        run: |
-          echo "=== Directory Structure ==="
-          ls -R public/
-
       - name: Create index page
         run: |
           cat > public/index.html <<'EOL'
@@ -123,8 +125,10 @@ jobs:
                 <div class="card">
                   <h2>API Documentation</h2>
                   <ul>
-                    <li><a href="https://it-at-m.github.io/eappointment/zmscitizenapi/public/doc/index.html">Zmscitizenapi API Documentation</a></li>
+                    <li><a href="https://it-at-m.github.io/eappointment/zmscitizenapi/public/doc/index.html">Zmscitizenapi Documentation</a></li>
                     <li><a href="https://it-at-m.github.io/eappointment/zmsapi/public/doc/index.html">Zmsapi Documentation</a></li>
+                    <li><a href="diagrams/zmsapi.html">Zmscitizenapi Schema</a></li>
+                    <li><a href="diagrams/zmscitizenapi.html">Zmsapi Schema</a></li>
                   </ul>
                 </div>
 
@@ -169,6 +173,29 @@ jobs:
           </html>
           EOL
 
+      - name: Download coverage reports
+        uses: actions/download-artifact@v4
+        with:
+          name: ${{ inputs.coverage_artifact }}
+          path: public
+
+      - name: Download API docs
+        uses: actions/download-artifact@v4
+        with:
+          name: ${{ inputs.api_docs_artifact }}
+          path: public
+
+      - name: Download security reports
+        uses: actions/download-artifact@v4
+        with:
+          name: ${{ inputs.security_artifact }}
+          path: public
+
+      - name: Debug - List directory structure
+        run: |
+          echo "=== Directory Structure ==="
+          ls -R public/
+
       - name: Setup Pages
         uses: actions/configure-pages@v5