Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Introduce link check on pull requests #1165

Open
StevenMaude opened this issue Mar 14, 2023 · 0 comments
Open

Introduce link check on pull requests #1165

StevenMaude opened this issue Mar 14, 2023 · 0 comments

Comments

@StevenMaude
Copy link
Contributor

StevenMaude commented Mar 14, 2023

Occasionally, broken links get introduced into the site, which we detect via a scheduled link check sometime they are included. It would be preferable to not introduce them at all.

To avoid this, we could check the files modified in pull request, in addition to having a regular scheduled link check.

If successful, we could also use this approach for other sites that we maintain.

Considerations:

  • The Lychee GitHub Action that we use doesn't have a built-in feature for this to dete; though there are scripted workarounds, see Checking only links from modified files in a Pull Request? lycheeverse/lychee-action#17
  • Sometimes links aren't broken, but simply blocked because the site blocks the GitHub Actions runner and/or the Lychee client. The fix then is to add the link to the .lycheeignore, which is less obvious. Might this be extra confusion for pull request authors?
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant