add workflow for link checking and spelling

.ci_support/check_links.sh

@@ -0,0 +1,19 @@
+#!/usr/bin/env bash
+set -euo pipefail
+
+CACHE_NAME=$(pwd)/.pytest-check-links-cache
+KNOWN_FAILS="\
+ibm \
+or declarativewidgets
+"
+
+cd _build/html
+
+
+pytest \
+  --check-links \
+  --check-links-cache \
+  --check-links-cache-name $CACHE_NAME \
+  --check-links-cache-expire-after 604800 \
+  --links-ext html \
+  -k "not ($KNOWN_FAILS)"

.ci_support/check_spelling.sh

@@ -0,0 +1,23 @@
+#!/usr/bin/env bash
+set -euo pipefail
+
+echo "checking spelling..."
+
+cd _build/html
+
+hunspell \
+  -d en-GB,en_US \
+  -p ../../.ci_support/dictionary.txt \
+  -l \
+  -H **/*.html \
+  | sort \
+  | uniq \
+  > check-spelling.txt
+
+if [ -s "check-spelling.txt" ]; then
+  echo "::warning ::{misspelled words found in built HTML}"
+  echo "::warning ::{$(cat check-spelling.txt)}"
+  exit 1
+else
+  echo "did not find any misspelled words"
+fi

.ci_support/dictionary.txt

@@ -0,0 +1,5 @@
+DeclarativeWidgets
+JEP
+Jupyter
+md
+Xeus

.ci_support/environment-spelling.yml

@@ -0,0 +1,8 @@
+name: spelling
+
+channels:
+  - conda-forge
+
+dependencies:
+  - hunspell-en >=2020.06.01
+  - hunspell >=1.7.0,<2

.ci_support/requirements-build.txt

@@ -0,0 +1 @@
+jupyter-book >=0.7.0,<1

.ci_support/requirements-check-links.txt

@@ -0,0 +1,2 @@
+pytest-check-links >=0.4.2,<1
+requests_cache >=0.5.2,<1

.github/workflows/check.yml

@@ -0,0 +1,121 @@
+name: Linting
+
+on:
+  pull_request:
+    branches:
+      - master
+  push:
+    branches:
+      - master
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+
+    - name: Set up Python 3.7
+      uses: actions/setup-python@v1
+      with:
+        python-version: 3.7
+
+    - name: Restore dependency cache
+      uses: actions/cache@v2
+      with:
+        path: ~/.cache/pip
+        key: pip-build-${{ hashFiles('.ci_support/requirements-build.txt') }}
+        restore-keys: |
+          pip-build-
+          pip-
+
+    - name: Install dependencies
+      run: |
+        pip install -U -r .ci_support/requirements-build.txt
+
+    - name: Build the book
+      run: |
+        jupyter-book build .
+
+    - name: Upload book
+      uses: actions/upload-artifact@v2
+      with:
+        name: _build
+        path: _build
+
+  spelling:
+    runs-on: ubuntu-latest
+    needs:
+      - build
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Download book
+        uses: actions/download-artifact@v2
+        with:
+          name: _build
+          path: _build
+
+      - name: Restore dependency cache
+        uses: actions/cache@v1
+        with:
+          path: ~/conda_pkgs_dir
+          key: conda-spelling-${{ hashFiles('.ci_support/environment-spelling.yml') }}
+          restore-keys: |
+            conda-spelling-
+            conda-
+
+      - name: Install dependencies
+        uses: goanpeca/[email protected]
+        with:
+          activate-environment: spelling
+          channel-priority: strict
+          environment-file: .ci_support/environment-spelling.yml
+          use-only-tar-bz2: true
+
+      - name: Find misspelled words
+        shell: bash -l {0}
+        run: |
+          bash .ci_support/check_spelling.sh
+
+  links:
+    runs-on: ubuntu-latest
+    needs:
+      - build
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Download book
+        uses: actions/download-artifact@v2
+        with:
+          name: _build
+          path: _build
+
+      - name: Restore link cache
+        uses: actions/cache@v2
+        with:
+          path: .pytest-check-links-cache.sqlite
+          key: links-checked-${{ hashFiles('.ci_support/requirements-check-links.txt') }}
+          restore-keys: |
+            links-checked-
+
+      - name: Restore dependency cache
+        uses: actions/cache@v2
+        with:
+          path: ~/.cache/pip
+          key: pip-check-links-${{ hashFiles('.ci_support/requirements-check-links.txt') }}
+          restore-keys: |
+            pip-check-links-
+            pip-
+
+      - name: Set up Python 3.7
+        uses: actions/setup-python@v1
+        with:
+          python-version: 3.7
+
+      - name: Install dependencies
+        run: |
+          pip install -U -r .ci_support/requirements-check-links.txt
+
+      - name: Find broken links
+        run: |
+          bash .ci_support/check_links.sh

.gitignore

@@ -28,3 +28,6 @@ node_modules
 
 # Jupyter Book
 _build
+
+# test cruft
+*.sqlite