search

opensearch-project / .github

Provides templates and resources for other OpenSearch project repositories.
Apache License 2.0
28 stars 71 forks source link

Add link checker #206

Closed Swiddis closed 6 days ago

Swiddis commented 1 week ago

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 commented 1 week ago

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.