internal: Implements build cache for API files

Author: steve-calvert-glean

.github/workflows/ci.yml

@@ -25,6 +25,15 @@ jobs:
       - name: Install dependencies
         run: yarn install --immutable
 
+      - name: Cache OpenAPI documentation
+        uses: actions/cache@v4
+        with:
+          path: .openapi-cache
+          key: openapi-cache-${{ runner.os }}-${{ hashFiles('openapi/**/*.yaml') }}
+          restore-keys: |
+            openapi-cache-${{ runner.os }}-
+            openapi-cache-
+
       - name: Check for incorrect support email
         run: |
           echo "Checking for usage of [email protected]..."
@@ -37,4 +46,6 @@ jobs:
           fi
 
       - name: Test build website
-        run: yarn build 
+        run: |
+          echo "Building website..."
+          yarn build 

.github/workflows/gh-pages.yml

@@ -0,0 +1,136 @@
+name: Sync OpenAPI Specs
+
+on:
+  schedule:
+    - cron: '0 2 * * *'  # Daily at 2 AM UTC
+  workflow_dispatch:
+    inputs:
+      reason:
+        description: 'Reason for manual sync (optional)'
+        required: false
+        default: 'Manual trigger'
+
+permissions:
+  contents: write
+  pull-requests: write
+
+jobs:
+  sync-specs:
+    runs-on: ubuntu-latest
+    outputs:
+      has_changes: ${{ steps.check-changes.outputs.has_changes }}
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+          token: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Download and process OpenAPI specs
+        id: download-specs
+        run: |
+          echo "📥 Downloading and processing OpenAPI specs..."
+
+          # Create spec directories if they don't exist
+          mkdir -p openapi/client openapi/indexing
+
+          # Download and capitalize client API spec
+          echo "Downloading and capitalizing client API spec..."
+          if yarn openapi:capitalize:client; then
+            echo "✅ Client API spec downloaded and capitalized successfully"
+          else
+            echo "❌ Failed to download/capitalize client API spec"
+            exit 1
+          fi
+
+          # Download and capitalize indexing API spec
+          echo "Downloading and capitalizing indexing API spec..."
+          if node scripts/openapi-capitalize-language.mjs https://gleanwork.github.io/open-api/specs/final/indexing.yaml openapi/indexing/indexing-capitalized.yaml; then
+            echo "✅ Indexing API spec downloaded and capitalized successfully"
+          else
+            echo "❌ Failed to download/capitalize indexing API spec"
+            exit 1
+          fi
+
+          echo "✅ All specs downloaded and processed successfully"
+
+      - name: Check for changes
+        id: check-changes
+        run: |
+          if [[ -n $(git status --porcelain openapi/) ]]; then
+            echo "has_changes=true" >> $GITHUB_OUTPUT
+            echo "📝 Changes detected in OpenAPI specs"
+            git diff --name-only openapi/
+          else
+            echo "has_changes=false" >> $GITHUB_OUTPUT
+            echo "✅ No changes in OpenAPI specs"
+          fi
+
+      - name: Create Pull Request with spec updates
+        if: steps.check-changes.outputs.has_changes == 'true'
+        id: create-pr
+        uses: peter-evans/create-pull-request@v5
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          commit-message: |
+            chore: sync latest OpenAPI specs
+
+            Automated sync of latest OpenAPI specifications from GitHub Pages.
+            Specs updated: client_rest.yaml, indexing.yaml
+          title: '🔄 Sync OpenAPI Specifications'
+          body: |
+            ## 🔄 Automated OpenAPI Specifications Sync
+
+            This PR contains the latest OpenAPI specifications synced from GitHub Pages.
+
+            ### Changes:
+            - Updated `openapi/client/client-capitalized.yaml` (Client API)
+            - Updated `openapi/indexing/indexing-capitalized.yaml` (Indexing API)
+
+            ### Trigger:
+            ${{ github.event_name == 'schedule' && 'Daily automated sync' || format('Manual trigger: {0}', github.event.inputs.reason) }}
+
+            ### Actions taken:
+            - Downloaded latest specs from GitHub Pages
+            - Committed changes to repository
+            - Created this PR for review
+
+            ---
+            🤖 This PR was created automatically by the OpenAPI spec sync workflow.
+          branch: sync-openapi-specs
+          delete-branch: true
+          labels: |
+            automated
+            openapi
+            dependencies
+
+      - name: Enable Auto-Merge
+        if: steps.check-changes.outputs.has_changes == 'true'
+        uses: peter-evans/enable-pull-request-automerge@v3
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          pull-request-number: ${{ steps.create-pr.outputs.pull-request-number }}
+          merge-method: squash
+
+  verify-build:
+    needs: sync-specs
+    if: needs.sync-specs.outputs.has_changes == 'true'
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Set up mise
+        uses: jdx/mise-action@v2
+        with:
+          cache: true
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Install dependencies
+        run: yarn install --immutable
+
+      - name: Verify build with new specs
+        run: yarn build

.github/workflows/sync-openapi-specs.yml

@@ -8,6 +8,7 @@
 .docusaurus
 .cache-loader
 .changelog-cache.json
+.openapi-cache
 
 # Misc
 .DS_Store