first attempt add link checks

flatironinstitute · Feb 4, 2025 · 8361cf8 · 8361cf8
1 parent 24b2b57
commit 8361cf8
Showing 1 changed file with 10 additions and 1 deletion.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -69,7 +69,7 @@ jobs:
       - name: Run tox
         run: tox -e check
 
-  prevent_docs_absolute_links:
+  prevent_docs_absolute_links_and_check_readme:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout code
@@ -81,6 +81,15 @@ jobs:
       - name: Check links
         run: ./bash_scripts/prevent_absolute_links_to_docs.sh
 
+      - name: Install markdown-link-check
+        run: npm install -g markdown-link-check
+
+      - name: Check links in README.md
+        run: markdown-link-check README.md --config .markdown-link-check.json
+
+      - name: Check links in CONTRIBUTING.md
+        run: markdown-link-check CONTRIBUTING.md --config .markdown-link-check.json
+
   check:
     if: ${{ !github.event.pull_request.draft }}
     needs: