ci: add guidelines to link checking workflow

espressif · Aug 20, 2024 · 85ee045 · 85ee045
1 parent f818b1b
commit 85ee045
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/.github/workflows/pr-check-links.yml b/.github/workflows/pr-check-links.yml
@@ -22,3 +22,11 @@ jobs:
             .
           # Fail action on broken links
           fail: true
+
+      - name: Suggestions
+        if: failure()
+        run: |
+          echo -e "\nPlease review the links reported in Link Checker step above."
+          echo -e "If a link is valid but fails due to a CAPTCHA challenge, IP blocking, login requirements, etc.,
+          consider adding such links to .lycheeignore file to bypass future checks.\n"
+          exit 1