🌱 Change link checker to lychee #517
Conversation
✅ Deploy Preview for metal3io-website ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
metal3-io-bot
added
the
size/M
peppi-lotta
force-pushed
the
peppi-lotta/change-link-checker
branch
2 times, most recently
from
f7fc30f to
3ece798
Compare
|
Report is nice, but it is full of false positives. If you look at it, it fails to local files, template variables etc which are not right. It seems to be parsing source rather than the live website? /hold |
metal3-io-bot
added
the
do-not-merge/hold
peppi-lotta
force-pushed
the
peppi-lotta/change-link-checker
branch
6 times, most recently
from
822e8f4 to
1ba7ec1
Compare
Signed-off-by: Peppi-Lotta <[email protected]>
peppi-lotta
force-pushed
the
peppi-lotta/change-link-checker
branch
from
1ba7ec1 to
f2bd337
Compare
| id: lycheemetal3io | ||
| uses: lycheeverse/lychee-action@f81112d0d2814ded911bd23e3beaa9dda9093915 # v2.1.0 | ||
| with: | ||
| args: --user-agent "Mozilla/5.0 (Windows NT 6.1; Win64; x64; rv:59.0) Gecko/20100101 Firefox/59.0" ${{ steps.extract.outputs.urls }} |
There was a problem hiding this comment.
I love how the user-agent is some 15 year old build of Firefox ;)
metal3-io-bot
added
lgtm
|
/cc @lentzi90 |
| http://localhost | ||
| https://0.0.0.0 | ||
| http://0.0.0.0 | ||
| https://github.com/issues |
There was a problem hiding this comment.
Scanner gets detected by github as bot, and gets 404. Bots should be using GH API for issue search.
There was a problem hiding this comment.
The actual link failing is filtered query to metal3 issues, IIRC good first issues. Its not the base issue url that we technically ignore.
metal3-io-bot
added
the
do-not-merge/hold
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: lentzi90 The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
metal3-io-bot
added
the
approved
|
/retitle 🌱 Change link checker to lychee I'll unhold, it cannot be any worse than old one ;-) |
metal3-io-bot
removed
the
do-not-merge/hold
Current Broken-link-checker is not actually checking in the https://metal3.io/ webpage. It is causing a lot of flakes like this:
#448
#485
In current link checker no URL is specified so it uses the default https://github.com/${{ github.repository }}{}. This means we are checking links in the site https://github.com/metal3-io/metal3-io.github.io instead of the intended https://metal3.io/ . To check all pages in a site we should serve a sitemap.xml as input to be checked.
I also think workflow should move to use lychee
https://lychee.cli.rs/introduction/#check-all-links-on-a-website
https://github.com/lycheeverse/lychee-action
Lychee is better documented, has active maintainers and widely adopted. Here is a workflow for that.
I've tested this code in my own fork. It creates quite nice reports and issues:
https://github.com/peppi-lotta/metal3-io.github.io/actions/runs/11834513843/job/32975333756
peppi-lotta#27