Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

External Links Checker using Lychee #1757

Open
wants to merge 11 commits into
base: main
Choose a base branch
from

Conversation

khadni
Copy link
Collaborator

@khadni khadni commented Feb 10, 2024

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.

Copy link

vercel bot commented Feb 10, 2024

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

@khadni khadni added the enhancement Enhance existing content or processes label Feb 10, 2024
@khadni khadni added the blocked Waiting for another PR or a release. label Feb 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
blocked Waiting for another PR or a release. enhancement Enhance existing content or processes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants