DOP-5448: Integrate Bump GH action to generate spec pages

.github/scripts/generateSpecMapping.js

@@ -0,0 +1,55 @@
+import fs from 'node:fs';
+import path from 'node:path';
+import { fileURLToPath } from 'node:url';
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+
+// Add new specs to be deployed to Bump here
+const SPEC_MAPPING = [
+  {
+    doc: 'f929d2d7-27d7-4591-b22f-6c2e543a7874',
+    file: 'openapi/v1-deprecated/v1.json',
+    branch: 'main',
+  },
+];
+
+function handleAdminAPIv2() {
+  const docId = '2accf4b8-a543-426c-94c3-794ae26b68be';
+  const directory = 'openapi/v2';
+  const filePath = path.join(__dirname, `../../${directory}/versions.json`);
+  const versions = JSON.parse(fs.readFileSync(filePath, 'utf8'));
+
+  if (!versions || !Array.isArray(versions)) {
+    return;
+  }
+
+  for (const [index, version] of versions.entries()) {
+    const openapiFilename = `openapi-${version}.json`;
+    const openapiFilePath = path.join(path.dirname(filePath), openapiFilename);
+
+    if (!fs.existsSync(openapiFilePath)) {
+      continue;
+    }
+
+    const file = `${directory}/${openapiFilename}`;
+    SPEC_MAPPING.push({
+      doc: docId,
+      file,
+      branch: version,
+    });
+
+    // We want the latest version to have its own version AND be the latest/default branch
+    if (index === versions.length - 1) {
+      SPEC_MAPPING.push({
+        doc: docId,
+        file,
+        branch: 'latest',
+      });
+    }
+  }
+}
+
+handleAdminAPIv2();
+// Output to GH action
+console.log(JSON.stringify(SPEC_MAPPING));

.github/workflows/generate-bump-pages.yml

@@ -0,0 +1,73 @@
+name: Check & deploy API documentation
+
+on:
+  workflow_dispatch: # Allow manual trigger in case of quick fix
+  push:
+    branches:
+      - main
+    paths:
+      - 'openapi/**.json'
+
+  pull_request:
+    branches:
+      - main
+    paths:
+      - 'openapi/**.json'
+
+permissions:
+  contents: read
+
+jobs:
+  create-matrix:
+    runs-on: ubuntu-latest
+    outputs:
+      matrix: ${{ steps.set-matrix.outputs.matrix }}
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+      - name: Setup Node
+        uses: actions/setup-node@v4
+      - name: Generate matrix
+        id: set-matrix
+        run: |
+          spec_mapping=$(node .github/scripts/generateSpecMapping.js)
+          echo "matrix=$spec_mapping" >> "$GITHUB_OUTPUT"
+
+  deploy-doc:
+    needs: create-matrix
+    if: ${{ github.event_name == 'push' || github.event_name == 'workflow_dispatch' }}
+    name: Deploy API documentation on Bump.sh
+    strategy:
+      matrix: 
+        spec-mapping: ${{ fromJson(needs.create-matrix.outputs.matrix) }}
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Deploy API documentation
+        uses: bump-sh/github-action@v1
+        with:
+          doc: ${{matrix.spec-mapping.doc}}
+          token: ${{secrets.BUMP_TOKEN}}
+          file: ${{matrix.spec-mapping.file}}
+          branch: ${{matrix.spec-mapping.branch}}
+
+  api-preview:
+    needs: create-matrix
+    if: ${{ github.event_name == 'pull_request' }}
+    name: Create API preview on Bump.sh
+    strategy:
+      matrix: 
+        spec-mapping: ${{ fromJSON(needs.create-matrix.outputs.matrix) }}
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Create API preview
+        uses: bump-sh/github-action@v1
+        with:
+          doc: ${{matrix.spec-mapping.doc}}
+          token: ${{secrets.BUMP_TOKEN}}
+          file: ${{matrix.spec-mapping.file}}
+          branch: ${{matrix.spec-mapping.branch}}
+          command: preview