script

Author: scsmithr

.github/workflows/ci.yml

@@ -30,3 +30,9 @@ jobs:
       - run: yarn lint
       - run: yarn format
       - run: yarn cspell
+
+      - name: Check links
+      - run: |
+          gem install jekyll bundler
+          bundler install
+          yarn links

package.json

@@ -2,14 +2,14 @@
   "name": "glaredb.github.io",
   "private": true,
   "scripts": {
-    "check:all": "yarn lint && yarn format && yarn cspell",
+    "check:all": "yarn lint && yarn format && yarn cspell && yarn links",
     "cspell": "cspell lint --config=cspell.json '**/*.md'",
     "dev": "bundle exec jekyll serve",
     "format": "prettier --check .",
     "format:fix": "prettier --write .",
     "lint": "markdownlint-cli2 \"**/*.{md,mdx}\" \"!node_modules\" \"!_site\"",
     "lint:fix": "markdownlint-cli2-fix \"**/*.{md,mdx}\" \"!node_modules\" \"!_site\"",
-    "links": "lychee -v http://localhost:4000"
+    "links": "./scripts/check-links.sh"
   },
   "devDependencies": {
     "cspell": "^6.31.1",

scripts/check-links.sh

@@ -0,0 +1,24 @@
+#!/usr/bin/env bash
+
+# Spins up the docs site (on a non-default port) and runs lychee against it to
+# check for broken links.
+
+set -e
+
+bundle exec jekyll serve --port 4001 > /dev/null 2>&1 &
+pid=$!
+
+attempts=0
+until curl --output /dev/null --silent --head --fail http://localhost:4001; do
+    attempts=$((attempts+1))
+    if [ $attempts -ge 10 ]; then
+        echo "max attempts exceeded"
+        exit 1
+    fi
+    echo "waiting for server"
+    sleep 1
+done
+
+lychee -v http://localhost:4001
+
+kill $pid