search

pyOpenSci / pyopensci.github.io

This is the website for pyOpenSci. Contributions welcome!!
https://www.pyopensci.org
Other
37 stars 61 forks source link

Remove html-proofer action and add lychee action for link checks #292

Closed willingc closed 6 months ago

willingc commented 9 months ago

This PR removes the problematic html-proofer action. It also adds an action to use Rust's lychee to check links.

Need to tweak config a bit but this is promising and much faster.

lwasser commented 9 months ago

thank you @willingc !!!

one note - htmlproofer does some other checks including looking for alt-tags and such for accessibility.

https://github.com/gjtorikian/html-proofer#whats-tested

there is a way to avoid new files / links being checked i just haven't had time to get this to work. but i think the accessibility checks are a good thing altho perhaps lychee does that too?? it would be awesome to get this issue fixed as it's a problem in all of our website repos including our guidebooks. once figured out we could fix everywhere.

willingc commented 9 months ago

@lwasser I will take a look for another accessibility checker. I know that I've used other tools for accessibility in the past, and I agree accessibility checkers are important (didn't realize that htmlproofer did that).

lwasser commented 9 months ago

thank you @willingc !! yes i have no opinion on what tools we use but do find it useful to check links and accessibility items on pr's !! so i appreciate your looking around for this. we can then apply whatever we implement here across all of our guidebooks too!!

this is the issue about this exact problem by the way !!

willingc commented 6 months ago

Closing this PR as stale and makes sense to keep HTML proofer in the short term.