[Feature] Add a broken link checker to the CI/CD pipeline

a11yproject / a11yproject.com

The A11Y Project is a community-driven effort to make digital accessibility easier.

https://a11yproject.com

Apache License 2.0

3.71k stars 551 forks source link

[Feature] Add a broken link checker to the CI/CD pipeline #1521

Open p2635 opened 1 year ago

p2635 commented 1 year ago

Thank you for suggesting a feature. Please fill out the following information:

Feature suggestion

Relates to my https://github.com/a11yproject/a11yproject.com/issues/1478#issuecomment-1443601296. Potentially implement something like https://github.com/marketplace/actions/broken-link-checker-action to improve the process.

Terms

[x] I have read, and agree to follow this project's Code of Conduct

hectorcoronado commented 1 year ago

👋🏻 @ericwbailey @p2635! Y'all still need help with this? Happy to take this issue if so

SaptakS commented 1 year ago

I think it might be good to have a broken link checker. Probably once per month, or once in 6 months. I am curious if it creates one issue with all the broken link results or multiple? It might become a little spammy if it creates multiple issues. Also, the github repo for the above github action seems to have been archived and not maintained anymore. I personally would prefer something which is better maintained and not archived.

p2635 commented 5 months ago

I was looking around and this link checker seems superior to a lot of the others: https://github.com/lycheeverse/lychee.

The README 'Features' section has a comparison against other link checkers. I tested it on my personal website and It looks promising.
GitHub action: https://github.com/marketplace/actions/lychee-broken-link-checker. It automates the process of creating one single GitHub issue after the checks are done.
How lychee works: https://lychee.cli.rs/how-it-works/

p2635 commented 5 months ago

I forked the a11y project and created an action for it, here is an example after an issue is automatically created: https://github.com/p2635/a11yproject.com/issues/1. The action can be configured to run on a cron job, so that suits your requirements for once per month or once every 6 months @SaptakS. I noticed sometimes there are false positives though like https://midnight-lizard.org/home... more to be investigated.

SaptakS commented 5 months ago

The false positives are definitely little concerning. Also, is the content of the automated issue created customisable? And can it also check that if there already exists an issue from before with the broken links?