Add linkchecker config (#1189)

* add a linkchecker config file to supress HTTP redirect warnings * added linkchecker config to CI
scalableminds · Sep 5, 2024 · ddb320c · ddb320c
1 parent e7ed52e
commit ddb320c
Show file tree

Hide file tree

Showing 3 changed files with 4 additions and 2 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -325,7 +325,7 @@ jobs:
           SLACK_HOOK: ${{ secrets.LINK_CHECKER_SLACK_HOOK }}
         run: |
           cd docs
-          poetry run linkchecker https://docs.webknossos.org > link_status || \
+          poetry run linkchecker --config linkcheckerrc https://docs.webknossos.org > link_status || \
             curl -X POST --data-urlencode "payload={\"text\": \":warning: Broken Links on doc.webknossos.org :warning:\n"'```'"\n$(cat link_status)\n"'```"}' \
               "$SLACK_HOOK"
 

diff --git a/.github/workflows/publish_docs.yml b/.github/workflows/publish_docs.yml
@@ -45,6 +45,6 @@ jobs:
         SLACK_HOOK: ${{ secrets.LINK_CHECKER_SLACK_HOOK }}
       run: |
         cd docs
-        poetry run linkchecker https://docs.webknossos.org > link_status || \
+        poetry run linkchecker --config linkcheckerrc https://docs.webknossos.org > link_status || \
           curl -X POST --data-urlencode "payload={\"text\": \":warning: Broken Links on doc.webknossos.org :warning:\n"'```'"\n$(cat link_status)\n"'```"}' \
             "$SLACK_HOOK"
diff --git a/docs/linkcheckerrc b/docs/linkcheckerrc
@@ -0,0 +1,2 @@
+[filtering]
+ignorewarnings=http-redirected