documentation icon indicating copy to clipboard operation
documentation copied to clipboard
verified publisher icon smartcontractkit

External Links Checker using Lychee

Open khadni opened this issue 1 year ago • 1 comments

This PR updates the external links checker using Lychee.

  • Error handling: To avoid false positives, HTTP 403 (Forbidden), 429 (Too Many Requests), and 406 (Not Acceptable) errors are not considered failures, acknowledging rate limits, access controls, and content negotiation issues.

  • Immediate reporting: A Markdown report of the link check results is generated in the workflow's summary to access identified issues, facilitating prompt corrections quickly.

  • GitHub Token Configuration: To enhance the workflow's efficiency in verifying GitHub URLs, we utilize the secrets.GITHUB_TOKEN for authentication. It mitigates rate-limiting issues encountered when fetching a high volume of GitHub URLs.

Note: While the GITHUB_TOKEN provides sufficient privileges for accessing URLs within the scope of this repository, it does not extend to external repositories. In future scenarios where the workflow needs to access a broader range of GitHub URLs beyond this repository, we'll consider leveraging a Personal Access Token to bypass rate limits more effectively.

khadni avatar Feb 10 '24 13:02 khadni

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated (UTC)
documentation ✅ Ready (Inspect) Visit Preview Feb 13, 2024 1:18pm

vercel[bot] avatar Feb 10 '24 13:02 vercel[bot]