Check links using lychee instead of a custom script #1355
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
also on failed check
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #1355 +/- ##
========================================
+ Coverage 3.59% 5.06% +1.47%
========================================
Files 13 33 +20
Lines 947 3436 +2489
Branches 152 424 +272
========================================
+ Hits 34 174 +140
- Misses 843 3260 +2417
+ Partials 70 2 -68
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
urmahp
reviewed
May 12, 2025
.github/workflows/check_links.yml
Outdated
| --cache | ||
| --cache-exclude-status 429 | ||
| --max-cache-age 2d | ||
| './**/*.md' './**/*.html' './**/*.rst' './**/*.cpp' './**/*.h' './**/*.py' |
Contributor
There was a problem hiding this comment.
Probably just me that is not fully into the lychee framework, but was is the purpose of this argument, it doesn't seem to be tied to any argument?
Member
Author
There was a problem hiding this comment.
That's the files that are going to be checked. I'll change it such that that's the last argument
urmahp
approved these changes
May 14, 2025
mergify bot
pushed a commit
that referenced
this pull request
May 14, 2025
(cherry picked from commit d38be8e) # Conflicts: # .github/workflows/check_links.yml # ur_robot_driver/README.md
urfeex
added a commit
that referenced
this pull request
May 15, 2025
urfeex
added a commit
that referenced
this pull request
May 15, 2025
) (#1361) Co-authored-by: Felix Exner <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Recently, our check_links workflow was failing very often, apparently GitHub has introduced new rate limits. I played around with lychee, a tool specifically made for link checking, which supports caching and even understands local links in Markdown and RST files.
It is significantly faster and allows caching built-in. And it helped me find three dead (local) links in the robot_driver's README.
Note: I expect things to fail with the initial run, as the cache has to be built up first.