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

Add link checker #206

Merged
merged 5 commits into from
Jul 1, 2024
Merged

Add link checker #206

merged 5 commits into from
Jul 1, 2024

Conversation

Swiddis
Copy link
Contributor

@Swiddis Swiddis commented Jun 28, 2024

Description

Following up on #205, this PR adds the Lychee link checking action we use on our team. I also went through and fixed all the lychee issues for the repo.

The issues links were false alarms since they did work correctly in the GitHub UI, but I still think refactoring makes it more portable, and adding exemptions to the checker for this would probably be more effort than it's worth.

The playground link being tricky is known, it gives a "too many redirects" error even after increasing the number of redirects. We ended up ignoring it in our repo as well, since this behavior happens even for dedicated redirect trackers like deref. It's possible this behavior is due to some sort of bot protection.

> curl -d"url=https://playground.opensearch.org" https://deref.link/deref
{"error":"Too Many Redirects"}

Issues Resolved

N/A

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

Swiddis added 3 commits June 28, 2024 09:57
Signed-off-by: Simeon Widdis <[email protected]>
Signed-off-by: Simeon Widdis <[email protected]>
Signed-off-by: Simeon Widdis <[email protected]>
dblock
dblock previously approved these changes Jun 28, 2024
Copy link
Member

@dblock dblock left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👏

Signed-off-by: Simeon Widdis <[email protected]>
@Swiddis Swiddis marked this pull request as ready for review June 28, 2024 17:43
@Swiddis
Copy link
Contributor Author

Swiddis commented Jun 28, 2024

since this behavior happens even for dedicated redirect trackers like deref

I found one that works and says it's 3 redirects, but Lychee is still failing with the error even after setting --max-redirects=30. Not sure what's up there.

Copy link
Member

@peternied peternied left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👏

@Swiddis Swiddis requested a review from dblock July 1, 2024 18:06
@dblock dblock merged commit df11b7b into opensearch-project:main Jul 1, 2024
3 checks passed
@Swiddis Swiddis deleted the link-checker branch July 8, 2024 18:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants