feat: add update-search-index action

Author: xiaoyu2er

.github/workflows/update-search-index.yml

@@ -0,0 +1,34 @@
+name: Update Search Index
+
+on:
+  push:
+    # Run when merging from official repo to check if translations are outdated
+    branches:
+      - main
+  workflow_dispatch: # Allow manual triggering
+
+# Add permissions needed for creating PRs
+permissions:
+  contents: write
+
+jobs:
+  translate:
+    runs-on: ubuntu-latest
+    steps:
+      # Checkout the repository first to access local actions
+      - name: Checkout code
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 1
+      - name: Setup Tools
+        uses: ./.github/actions/setup
+      - name: Build docs app
+        shell: bash
+        run: pnpm build:docs
+      - name: Run search index update
+        shell: bash
+        run: pnpm run update-search-index
+        env:
+          ORAMA_PRIVATE_API_KEY_EN: ${{ secrets.ORAMA_PRIVATE_API_KEY_EN }}
+          ORAMA_PRIVATE_API_KEY_ZH_HANS: ${{ secrets.ORAMA_PRIVATE_API_KEY_ZH_HANS }}
+        

apps/docs/.env.example

@@ -1,3 +1,4 @@
 EN_DOMAIN=nextjs.im
 ZH_HANS_DOMAIN=zh-hans.nextjs.im
-ORAMA_PRIVATE_API_KEY=
+ORAMA_PRIVATE_API_KEY_EN=
+ORAMA_PRIVATE_API_KEY_ZH_HANS=

apps/docs/package.json

@@ -4,7 +4,7 @@
   "private": true,
   "scripts": {
     "build": "next build",
-    "build:post": "tsx ./scripts/post-build.mts",
+    "update-search-index": "tsx ./scripts/update-search-index.mts",
     "dev": "next dev --turbo",
     "start": "next start",
     "postinstall": "fumadocs-mdx",

apps/docs/scripts/update-orama-index.mts

@@ -8,8 +8,11 @@ import { sync } from '../src/lib/orama/orama-cloud';
 export async function updateSearchIndexes(): Promise<void> {
   for (const item of ORAMA_CONFIGS) {
     const { locale, privateKey, index } = item;
+    if (!privateKey) {
+      console.error(`No private key found for locale: ${locale}`);
+      continue;
+    }
     const manager = new CloudManager({ api_key: privateKey });
-
     // Get all .body files in the static directory
     const staticDir = path.join(`.next/server/app/${locale}/static`);
     let allRecords: OramaDocument[] = [];

apps/docs/scripts/post-build.mts renamed to apps/docs/scripts/update-search-index.mts

@@ -1,10 +1,8 @@
 import type { Locale } from 'next-intl';
-// PrivateApiKey is only used in the server
-const privateApiKey = process.env.ORAMA_PRIVATE_API_KEY;
 
 const ORAMA_EN_CONFIG = {
   locale: 'en',
-  privateKey: privateApiKey || '',
+  privateKey: process.env.ORAMA_PRIVATE_API_KEY_EN || '',
   apiKey: '4DujbZrvGuklBRFcZBtegX3fV1lzNXnU',
   index: 'vuywlowcbl1w3s2jtvq5ysxl',
   endpoint: 'https://cloud.orama.run/v1/indexes/en-ai00ky',
@@ -14,7 +12,7 @@ type ORAMA_EN_CONFIG = typeof ORAMA_EN_CONFIG;
 
 const OORAMA_ZH_HANS_CONFIG = {
   locale: 'zh-Hans',
-  privateKey: privateApiKey || '',
+  privateKey: process.env.ORAMA_PRIVATE_API_KEY_ZH_HANS || '',
   apiKey: '6nEUS4tyXiajWxZ8qMEQMzzLoOYTuLSk',
   index: 'vcwl00bwd64h3pa8yq8x107y',
   endpoint: 'https://cloud.orama.run/v1/indexes/zh-hans-js5ujm',

apps/docs/src/lib/orama/config.ts

@@ -31,7 +31,10 @@ export async function sync(
     );
     await index.insert(chunk);
   }
-  if (autoDeploy) await index.deploy();
+  if (autoDeploy) {
+    console.log('Deploying index...');
+    await index.deploy();
+  }
   console.log('All operations completed');
 }
 

apps/docs/src/lib/orama/orama-cloud.ts

@@ -9,7 +9,9 @@
     "lint": "biome lint .",
     "lint:fix": "biome lint --write .",
     "dev": "pnpm --filter @next-i18n/translate --filter @next-i18n/docs --parallel dev",
-    "translate": "pnpm --filter @next-i18n/docs translate"
+    "translate": "pnpm --filter @next-i18n/docs translate",
+    "build:docs": "pnpm --filter @next-i18n/docs build",
+    "update-search-index": "pnpm --filter @next-i18n/docs update-search-index"
   },
   "keywords": [],
   "devDependencies": {