ci: verify the order of the search results

We definitely want the search results for, say, "commit" to show the manual page of that command first. This took quite a bit of work to accomplish, including a change to Pagefind itself (CloudCannon/pagefind#534) as well as some extensive fiddling with the ranking weights (including, I kid you not, running a Powell's optimization of the weights). To ensure that the results are shown in the desired order, let's add an explicit check for that in the PR builds. Signed-off-by: Johannes Schindelin <[email protected]>
dscho · Sep 7, 2024 · 3b109d9 · 3b109d9
1 parent 8913fef
commit 3b109d9
Showing 1 changed file with 14 additions and 0 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -33,3 +33,17 @@ jobs:
       with:
         name: pages
         path: pages.tar.gz
+
+    - name: verify search results
+      run: |
+        set -x
+        res=0
+        for term in commit config log rev-parse
+        do
+          node ./script/run-pagefind.js "$term" | tee search.results >&2
+          grep "^1. /docs/git-$term\\.html" search.results || {
+            echo "::error::Search for $term failed to show the manual page first" >&2
+            res=1
+          }
+        done
+        exit $res