From ccd24275063915f29c0fff69a3848601536a51e2 Mon Sep 17 00:00:00 2001
From: Silvan Mosberger <silvan.mosberger@tweag.io>
Date: Thu, 18 Apr 2024 23:59:16 +0200
Subject: [PATCH] Check documentation links with xrefcheck

---
 .github/workflows/main.yml | 10 ++++++++++
 1 file changed, 10 insertions(+)

diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
index d2db5ef..da94cd6 100644
--- a/.github/workflows/main.yml
+++ b/.github/workflows/main.yml
@@ -38,6 +38,16 @@ jobs:
         env:
           GH_TOKEN: ${{ github.token }}
 
+  # Make sure that all links in Markdown documents are valid
+  xrefcheck:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      # While this has a Nix build available, it needs to evaluate and build so much
+      # that I don't think it's worth adding it to the nix-build.
+      - uses: serokell/xrefcheck-action@v1
+
   test-update:
     runs-on: ubuntu-latest
     steps: