Add a link checker to CI. (#122)

Solves #120.
UCL-ARC · Jul 26, 2023 · f9399d0 · f9399d0
1 parent caf059e
commit f9399d0
Show file tree

Hide file tree

Showing 2 changed files with 36 additions and 6 deletions.
diff --git a/.github/workflows/links.yml b/.github/workflows/links.yml
@@ -0,0 +1,30 @@
+# This is a basic workflow to check for broken links with GitHub Actions
+
+name: Link Checker
+
+on:
+  pull_request:
+    branches: [main]
+  workflow_dispatch:
+
+jobs:
+  linkChecker:
+    timeout-minutes: 2
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Link Checker
+        id: lychee
+        uses: lycheeverse/[email protected]
+        with:
+          # Exclude the image.sc forum (which works) but returns 403 from
+          # github runners, ignore the project slug README since the links are
+          # necessarily not real links - i.e. demos and to be filled by
+          # cookiecutter values.
+          args: "--verbose --exclude https://forum.image.sc/ --exclude-path '{{cookiecutter.project_slug}}/README.md'  -- ."
+          fail: true
+          jobSummary: true
+        env:
+          GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
diff --git a/docs/pages/docs.md b/docs/pages/docs.md
@@ -7,12 +7,12 @@ layout: default
 
 ## Doc building
 
-| Name                                            | Short description                                               | 🚦  | Used by                                     |
-| ----------------------------------------------- | --------------------------------------------------------------- | :-: | ------------------------------------------- |
-| [sphinx](https://www.sphinx-doc.org/en/master/) | Generates documentation from reStructuredText or Markdown files | 🟢  | [TLOModel](https://github.com/UCL/TLOmodel) |
-| [mkdocs](https://www.mkdocs.org/)               | Generates documentation from Markdown files                     | 🟠  |                                             |
-| [pdoc](https://pdoc.dev/)                       | Auto-generates API documentation from docstrings                | 🟠  | [MICI](https://github.com/matt-graham/mici) |
-| [gitbook](https://www.gitbook.com/)             | General documentation builder; integrates with GitHub           | 🟠  |                                             |
+| Name                                            | Short description                                               | 🚦  | Used by                                                                |
+| ----------------------------------------------- | --------------------------------------------------------------- | :-: | ---------------------------------------------------------------------- |
+| [sphinx](https://www.sphinx-doc.org/en/master/) | Generates documentation from reStructuredText or Markdown files | 🟢  | [WAZP](https://github.com/SainsburyWellcomeCentre/WAZP/tree/main/docs) |
+| [mkdocs](https://www.mkdocs.org/)               | Generates documentation from Markdown files                     | 🟠  |                                                                        |
+| [pdoc](https://pdoc.dev/)                       | Auto-generates API documentation from docstrings                | 🟠  | [MICI](https://github.com/matt-graham/mici)                            |
+| [gitbook](https://www.gitbook.com/)             | General documentation builder; integrates with GitHub           | 🟠  |                                                                        |
 
 <details>
 <summary> 🟢 explaination</summary>