From 596f15650eecfa9bf46bc2196367e2adaebe3333 Mon Sep 17 00:00:00 2001
From: Gereon Kremer <gkremer@stanford.edu>
Date: Thu, 2 Dec 2021 11:48:21 -0800
Subject: [PATCH] Check docs for broken links before uploading (#7729)

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 | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/.github/workflows/docs_upload.yml b/.github/workflows/docs_upload.yml
index 98eb24943..937496d0a 100644
--- a/.github/workflows/docs_upload.yml
+++ b/.github/workflows/docs_upload.yml
@@ -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 }}
-- 
2.30.2