Add ReDoc GitHub Pages deployment for OpenAPI spec

bilalebi · bilalebi · commit 6732b72121ec · 2025-11-13T16:40:59.000Z
diff --git a/.github/workflows/deploy-docs.yml b/.github/workflows/deploy-docs.yml
@@ -1,37 +1,42 @@
-name: Deploy API Docs
+name: Deploy OpenAPI docs to GitHub Pages
+
 on:
   push:
-    branches: [main, add-genome-groups]
-    paths: ['APISpecification.yaml']  # Only run when spec changes
+    branches:
+      - main
+      - add-genome-groups
+    paths:
+      - 'docs/**'
+      - '.github/workflows/deploy-docs.yml'
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: 'pages'
+  cancel-in-progress: true
 
 jobs:
   deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
     runs-on: ubuntu-latest
+
     steps:
-      - uses: actions/checkout@v4
-
-      - name: Create documentation page
-        run: |
-          cat > index.html << 'EOF'
-          <!DOCTYPE html>
-          <html>
-            <head>
-              <title>API Documentation</title>
-              <meta charset="utf-8"/>
-              <meta name="viewport" content="width=device-width, initial-scale=1">
-              <link href="https://fonts.googleapis.com/css?family=Montserrat:300,400,700|Roboto:300,400,700" rel="stylesheet">
-              <style> body { margin: 0; padding: 0; } </style>
-            </head>
-            <body>
-              <redoc spec-url='APISpecification.yaml'></redoc>
-              <script src="https://cdn.redoc.ly/redoc/latest/bundles/redoc.standalone.js"></script>
-            </body>
-          </html>
-          EOF
+      - name: Checkout
+        uses: actions/checkout@v4
 
-      - name: Deploy to GitHub Pages
-        uses: peaceiris/actions-gh-pages@v3
+      - name: Setup Pages
+        uses: actions/configure-pages@v5
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
         with:
-          github_token: ${{ secrets.GITHUB_TOKEN }}
-          publish_dir: ./
-          publish_branch: gh-pages
+          path: docs
+
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4
diff --git a/docs/APISpecification.yaml b/docs/APISpecification.yaml
diff --git a/docs/index.html b/docs/index.html
@@ -0,0 +1,23 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <title>API Documentation</title>
+    <!-- ReDoc standalone bundle via CDN -->
+    <script src="https://cdn.jsdelivr.net/npm/redoc/bundles/redoc.standalone.js"></script>
+    <style>
+      body {
+        margin: 0;
+        padding: 0;
+      }
+      redoc {
+        width: 100vw;
+        height: 100vh;
+      }
+    </style>
+  </head>
+  <body>
+    <!-- ReDoc mounts here -->
+    <redoc spec-url="APISpecification.yaml"></redoc>
+  </body>
+</html>
