Check for broken links in CI test job

Author: natikgadzhi

Gemfile

@@ -4,4 +4,8 @@ source 'https://rubygems.org'
 gem 'jekyll', '~> 4.2.1'
 gem 'jekyll-redirect-from'
 
+# html-proofer checks for broken links.
+# used in docker-compose.yml test job
+gem 'html-proofer'
+
 gem "webrick", "~> 1.7"

docker-compose.yaml

@@ -40,10 +40,11 @@ services:
 
    test:
       <<: *common
-      command: /bin/bash -cl "
-        bundle check
-        && bundle exec jekyll doctor --source /srv/jekyll --destination /output
-        && bundle exec jekyll build --source /srv/jekyll --destination /output"
+      command: /bin/bash -cl "/code/scripts/test.sh"
+      volumes:
+         - .:/srv/jekyll:cached
+         - ./.output:/output:z
+         - .:/code:z
 
    website:
      <<: *common

scripts/test.sh

@@ -0,0 +1,14 @@
+set -eu
+here="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
+cd "$here/.."
+
+bundle check
+bundle exec jekyll doctor --source /srv/jekyll --destination /output
+bundle exec jekyll build --source /srv/jekyll --destination /output
+
+# This line runs broken link checks: https://github.com/gjtorikian/html-proofer
+bundle exec htmlproofer \
+    --ignore-status-codes "429" \
+    --only_4xx \
+    --ignore-urls twitter.com \
+    /output