feat: add index generation workflow on main update

.github/workflows/update-search.yml

@@ -0,0 +1,13 @@
+name: Update Search Index
+on:
+  push:
+    branches:
+      - main
+jobs:
+  update:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Make sure we have node and dependencies
+        run: npm i
+      - name: Process and send index updates to Algolia
+        run: npm run build-index

generate-search-index.js

@@ -6,11 +6,16 @@ import matter from "gray-matter";
 import { remark } from "remark";
 import remarkMdx from "remark-mdx";
 // Using strip because stripping via remarkMdx rendering wasn't working
-import strip from 'strip-markdown'
+import strip from "strip-markdown";
 import { exit } from "process";
 
 const client = algoliasearch("ECUG3H1E0M", process.env.ALGOLIA_KEY);
 
+if (!process.env.ALGOLIA_KEY) {
+  console.error("ALGOLIA_KEY not set");
+  exit(1);
+}
+
 const index = client.initIndex("documentation");
 
 const sitemap = [];
@@ -53,8 +58,6 @@ function walk(dir) {
         content = fileContents;
       }
 
-
-
       // Get rid of markdown
       if (filepath.indexOf(".mdx") > -1 || filepath.indexOf(".md") > -1) {
         content = String(remark().use(strip).processSync(content));
@@ -73,11 +76,10 @@ function walk(dir) {
       // Fix newlines
       content = content.replace(/\n/g, " ");
 
-
       // Shorten to fit in Algolia Index
       if (content) {
         content = content.substring(0, 8000);
-      }      
+      }
 
       let title = data?.title;
       const pattern = /^# (.*)$/;
@@ -96,7 +98,6 @@ function walk(dir) {
         }
       }
 
-
       sitemap.push({
         url: url,
         lastmod: mtime,
@@ -129,7 +130,7 @@ try {
 }
 
 function stripTags(html) {
-  if(!html || !html.replace) {
+  if (!html || !html.replace) {
     return html;
   }
   // Create a regular expression to match all HTML tags.

package.json

@@ -11,7 +11,8 @@
     "start": "astro dev",
     "build": "astro build",
     "preview": "astro preview",
-    "astro": "astro"
+    "astro": "astro",
+    "build-index": "node ./generate-search-index.js"
   },
   "dependencies": {
     "@astrojs/markdown-remark": "^3.2.0",