CI: verify docs resources

.github/workflows/deploy-docs.yml

@@ -59,9 +59,29 @@ jobs:
         run: echo "##[set-output name=flag;]$([[ \"${GITHUB_REF#refs/heads/}\" == \"master\" ]] && echo \"--prod\" || true)"
 
       - name: Deploy docs
+        id: deploy
         uses: netlify/actions/cli@master
         with:
           args: deploy --dir='apps/govuk-docs/.netlify/publish/' --functions='apps/govuk-docs/.netlify/functions/' ${{ steps.target.outputs.flag }}
         env:
           NETLIFY_SITE_ID: ${{ secrets.NETLIFY_SITE_ID }}
           NETLIFY_AUTH_TOKEN: ${{ secrets.NETLIFY_AUTH_TOKEN }}
+
+      - name: Scan docs links
+        id: linkscan
+        uses: JustinBeckwith/linkinator-action@v1
+        with:
+          config: apps/govuk-docs/linkinator.config.json
+          paths: ${{ steps.deploy.outputs.NETLIFY_URL }}
+
+      - name: Check docs scan results
+        uses: r26d/jq-action@master
+        env:
+          SELECTOR: '.links | .[] | select(.state | contains("BROKEN"))'
+          TEMPLATE: '.state, " link [", .status, "] in page ", .parent, ", for target: ", .url, "\n"'
+          OUTCOME: '.passed | "Links and assets verified: ", .'
+        with:
+          cmd: |
+            cd apps/govuk-docs/
+            echo "${{ steps.linkscan.outputs.value }}" \
+              | jq -jre "( ${{ env.SELECTOR }} | ${{ env.TEMPLATE }} ), ( ${{ env.OUTCOME }} )"

apps/govuk-docs/check-links.sh

@@ -0,0 +1,28 @@
+#!/bin/bash +x
+
+set -e
+SCRIPT_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
+cd "${SCRIPT_DIR}"
+
+[ -d node_modules ] && [ -f dist/server/index.js ] || make deps build > /dev/null
+set +e
+npm run ssr > /dev/null &
+server=$!
+
+selector='.links | .[] | select(.state | contains("BROKEN"))'
+template='.state, " link [", .status, "] in page ", .parent, ", for target: ", .url, "\n"'
+outcome='.passed | "Links and assets verified: ", .'
+curl -fs \
+  --retry 15 \
+  --retry-delay 2 \
+  --retry-max-time 30 \
+  --retry-connrefused \
+  http://localhost:8080/ > /dev/null && \
+  linkinator http://localhost:8080 \
+    --verbosity warning \
+    --config ./linkinator.config.json \
+    | jq -jre "( ${selector} | ${template} ), ( ${outcome} )"
+result=$?
+echo
+kill $server
+exit $result

apps/govuk-docs/linkinator.config.json

@@ -0,0 +1,6 @@
+{
+  "format": "json",
+  "recurse": true,
+  "verbosity": "info",
+  "timeout": 10000
+}

apps/govuk-docs/package.json

@@ -6,12 +6,13 @@
   "main": "dist/server/index.js",
   "scripts": {
     "start": "node .",
-    "test": "echo \"Error: no test specified\" && exit 1",
+    "test": "exec ./check-links.sh",
     "build": "webpack",
     "package:serverless": "sls package",
     "clean": "rm -rf .serverless dist",
     "dev": "NODE_ENV=development node-hot --fork | bunyan",
-    "dev:ssr": "NODE_ENV=development SSR_ONLY=true node-hot --fork | bunyan"
+    "dev:ssr": "NODE_ENV=development SSR_ONLY=true node-hot --fork | bunyan",
+    "ssr": "NODE_ENV=production SSR_ONLY=true exec node ."
   },
   "author": "Daniel A.C. Martin <[email protected]> (http://daniel-martin.co.uk/)",
   "license": "MIT",
@@ -30,6 +31,7 @@
     "@types/react-router-dom": "^5.1.5",
     "@types/webpack-env": "^1.15.2",
     "bunyan": "^1.8.12",
+    "linkinator": "^2.13.6",
     "node-hot-loader": "^1.19.0",
     "react": "^16.9.55",
     "react-dom": "^16.9.55",