integrate GH action to publish to algolia

Author: e111077

.github/workflows/build-and-publish-search-index.yml

@@ -0,0 +1,27 @@
+name: Build And Publish Search Index
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  build-publish-search-index:
+    runs-on: ubuntu-latest
+    timeout-minutes: 10
+    steps:
+      - uses: google/wireit@setup-github-actions-caching/v1
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v2
+        with:
+          node-version: 18
+          cache: npm
+          cache-dependency-path: '**/package-lock.json'
+
+      - run: npm ci
+      - id: build
+        run: npm run build
+      - name: Publish algolia search index
+        env:
+          ALGOLIA_WRITE_KEY: ${{ secrets.LIT_DEV_ALGOLIA_WRITE_KEY }}
+        run: ALGOLIA_WRITE_KEY=$ALGOLIA_WRITE_KEY node packages/lit-dev-tools-esm/lib/upload-algolia-index.js

.gitignore

@@ -10,6 +10,7 @@ packages/lit-dev-content/rollupout
 packages/lit-dev-content/site/fonts/manrope
 packages/lit-dev-content/temp
 packages/lit-dev-content/samples/js
+packages/lit-dev-content/src/public-vars.ts
 
 packages/lit-dev-api/api-data/*/repo/
 packages/lit-dev-api/api-data/*/INSTALLED

packages/lit-dev-content/package.json

@@ -22,6 +22,7 @@
     "dev:build:eleventy": "wireit",
     "dev:build:eleventy:watch": "wireit",
     "dev:serve": "wireit",
+    "copy-keys": "wireit",
     "prod:build": "wireit",
     "prod:build:assets": "wireit"
   },
@@ -135,6 +136,9 @@
       "output": [
         "lib"
       ],
+      "dependencies": [
+        "copy-keys"
+      ],
       "command": "../../node_modules/.bin/tsc --build --pretty",
       "clean": "if-file-deleted"
     },
@@ -162,6 +166,15 @@
         "samples/js/**"
       ],
       "command": "node ../lit-dev-tools-esm/lib/generate-js-samples.js"
+    },
+    "copy-keys": {
+      "files": [
+        "../../public-vars.json"
+      ],
+      "output": [
+        "src/public-vars.ts"
+      ],
+      "command": "cp ../../public-vars.json public-vars.tsorig && echo 'export default ' > public-vars.tstemp && cat public-vars.tsorig >> public-vars.tstemp && cp public-vars.tstemp src/public-vars.ts && rm public-vars.tstemp && rm public-vars.tsorig"
     }
   },
   "devDependencies": {

packages/lit-dev-content/src/components/litdev-search.ts

@@ -29,6 +29,7 @@ import algoliasearch, {
   SearchIndex,
 } from 'algoliasearch/dist/algoliasearch-lite.esm.browser.js';
 import {Task, TaskStatus} from '@lit-labs/task';
+import vars from '../public-vars.js';
 
 /**
  * Representation of each document indexed by Minisearch.
@@ -191,12 +192,12 @@ export class LitDevSearch extends LitElement {
   private _searchText: string = '';
 
   private static _algoliaSearchClient: SearchClient = algoliasearch(
-    'OC866NN61X',
-    '33401c252374747a39ef3b42c9f701ac'
+    vars.algolia.appId,
+    vars.algolia.searchOnlyKey
   );
 
   private static _algoliaSearch: SearchIndex =
-    LitDevSearch._algoliaSearchClient.initIndex('lit_dev_test');
+    LitDevSearch._algoliaSearchClient.initIndex(vars.algolia.index);
 
   private _searchTask: Task<string[], Suggestion[]> | null = null;
 

packages/lit-dev-content/tsconfig.json

@@ -6,8 +6,9 @@
     "incremental": true,
     "composite": true,
     "tsBuildInfoFile": "lib/.tsbuildinfo",
-    "skipLibCheck": true
+    "skipLibCheck": true,
+    "resolveJsonModule": true
   },
-  "include": ["src/**/*.ts"],
+  "include": ["src/**/*.ts", "src/**/*.json"],
   "exclude": []
 }

packages/lit-dev-tools-cjs/src/search/plugin.ts

@@ -19,6 +19,7 @@ type UrlToFile = Map<string, string>;
  */
 interface UserFacingPageData {
   id: number;
+  objectID: number;
   relativeUrl: string;
   title: string;
   heading: string;
@@ -105,6 +106,7 @@ export async function createSearchIndex(outputDir: '_dev' | '_site') {
         // facing data to display in the suggested results.
         searchIndex.push({
           id: id++,
+          objectID: id,
           title: title.replace(/ – Lit$/, ''),
           heading,
           relativeUrl: relUrl.replace(/index.html$/, '') + (fragment ?? ''),

packages/lit-dev-tools-esm/src/upload-algolia-index.ts

@@ -0,0 +1,19 @@
+import algolia from 'algoliasearch';
+import fs from 'fs';
+
+const varsRaw = fs.readFileSync('../../public-vars.json', 'utf8');
+const vars = JSON.parse(varsRaw);
+const searchIndexRaw = fs.readFileSync(
+  '../lit-dev-content/_site/searchIndex.json',
+  'utf8'
+);
+const searchIndex = JSON.parse(searchIndexRaw);
+const ALGOLIA_WRITE_KEY = process.env.ALGOLIA_WRITE_KEY;
+
+if (!ALGOLIA_WRITE_KEY) {
+  throw new Error('ALGOLIA_WRITE_KEY environment variable is not set');
+}
+
+const client = algolia(vars.algolia.appId, ALGOLIA_WRITE_KEY);
+const index = client.initIndex(vars.algolia.indexName);
+await index.replaceAllObjects(searchIndex);

public-vars.json

@@ -0,0 +1,7 @@
+{
+  "algolia": {
+    "appId": "OC866NN61X",
+    "searchOnlyKey": "33401c252374747a39ef3b42c9f701ac",
+    "index": "lit.dev"
+  }
+}