Check docs for broken links before uploading (#7729)
authorGereon Kremer <gkremer@stanford.edu>
Thu, 2 Dec 2021 19:48:21 +0000 (11:48 -0800)
committerGitHub <noreply@github.com>
Thu, 2 Dec 2021 19:48:21 +0000 (19:48 +0000)
We currently have a few broken links in our documentation. This PR make our CI check for broken links before uploading it. Note that it will not fail any job, so we still need to check the output occasionally for now.

.github/workflows/docs_upload.yml

index 98eb24943177bb0cb97eef378bf19e68128b7684..937496d0ae831e8f7512ad66a84bdca101379e13 100644 (file)
@@ -53,6 +53,12 @@ jobs:
       - name: Unpack artifact
         run: unzip download.zip -d docs-new/
       
+      - name: Check for broken links
+        continue-on-error: true
+        run: |
+          python3 -m pip install linkchecker
+          linkchecker --check-extern docs-new/index.html
+
       - name: Setup Context
         run: |
           HASH=${{ github.event.workflow_run.head_commit.id }}