Merge branch 'docs-link-test' into '0.5-docs'

Add testing of links in docs

See merge request !206

.gitlab-ci.yml

@@ -18,9 +18,8 @@ stages:
 
 # Theodolite Docs
 
-build-docs:
-  stage: build
-  image: ruby:2.7
+.docs:
+  image: alpine/bundle:3.0.3
   tags:
     - exec-docker
   cache:
@@ -28,14 +27,24 @@ build-docs:
       - docs/vendor
   before_script:
     - cd docs
-    - gem install bundler
     - bundle config set --local path 'vendor'
     - bundle install
+
+build-docs:
+  stage: build
+  extends: .docs
   script: bundle exec jekyll build
   artifacts:
     paths:
       - docs/_site
 
+test-docs-links:
+  stage: test
+  extends: .docs
+  needs:
+    - build-docs
+  script: bundle exec htmlproofer --assume-extension --allow_hash_href --url-ignore "/favicon.ico" ./_site
+
 
 # Theodolite Helm Chart
 

docs/Gemfile

@@ -19,6 +19,8 @@ gem "github-pages", "~> 215", group: :jekyll_plugins
   #gem "jekyll-feed", "~> 0.12"
 #end
 
+gem 'html-proofer'
+
 # Windows and JRuby does not include zoneinfo files, so bundle the tzinfo-data gem
 # and associated library.
 platforms :mingw, :x64_mingw, :mswin, :jruby do

docs/Gemfile.lock

@@ -95,6 +95,14 @@ GEM
     html-pipeline (2.14.0)
       activesupport (>= 2)
       nokogiri (>= 1.4)
+    html-proofer (3.19.2)
+      addressable (~> 2.3)
+      mercenary (~> 0.3)
+      nokogumbo (~> 2.0)
+      parallel (~> 1.3)
+      rainbow (~> 3.0)
+      typhoeus (~> 1.3)
+      yell (~> 2.0)
     http_parser.rb (0.6.0)
     i18n (0.9.5)
       concurrent-ruby (~> 1.0)
@@ -221,13 +229,17 @@ GEM
     multipart-post (2.1.1)
     nokogiri (1.11.7-x86_64-linux)
       racc (~> 1.4)
+    nokogumbo (2.0.5)
+      nokogiri (~> 1.8, >= 1.8.4)
     octokit (4.21.0)
       faraday (>= 0.9)
       sawyer (~> 0.8.0, >= 0.5.3)
+    parallel (1.21.0)
     pathutil (0.16.2)
       forwardable-extended (~> 2.6)
     public_suffix (4.0.6)
     racc (1.5.2)
+    rainbow (3.0.0)
     rb-fsevent (0.11.0)
     rb-inotify (0.10.1)
       ffi (~> 1.0)
@@ -259,6 +271,7 @@ GEM
       unf_ext
     unf_ext (0.0.7.7)
     unicode-display_width (1.7.0)
+    yell (2.2.2)
     zeitwerk (2.4.2)
 
 PLATFORMS
@@ -267,6 +280,7 @@ PLATFORMS
 
 DEPENDENCIES
   github-pages (~> 215)
+  html-proofer
   minima (~> 2.5)
   tzinfo (~> 1.2)
   tzinfo-data