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

Improve link validation with lychee-action #263

Merged
merged 2 commits into from Apr 22, 2022

Conversation

vpereira01
Copy link
Collaborator

@vpereira01 vpereira01 commented Mar 24, 2022

Replaced awesome-bot validation with lychee-action to improve stability and validation quality. You can notice that some links are incorrect and awesome-bot has not give us that feedback. (404 errors).

  • lychee-action which uses lychee seems more stable and has retry features make it more suitable the GH Action
  • lychee repo with nice comparison table https://github.com/lycheeverse/lychee#features
  • lychee default retry is 3 which seems good enough.
  • Added dependabot rule to get PRs with updates

Some limitations/issues/annoyances:

  • When checking step output check the HTTP Status code between the square brackets since the error message is not that clear. Example: ✗ [404] https://www.symantec.com/about/careers | Network error: Not Found means HTTP 404 Not Found
  • Timeouts can mean a domain that does not exist. Example ⧖ [TIMEOUT] https://skyhour.com/ | Timeout
  • GitHub Action UI parses some messages weirdly. This message ✗ [ERROR] http://www.alticelabs.com/ | Network error: No status code is parsed by the UI and shows as Error: R] http://www.alticelabs.com/ | Network error: No status code

This change can be updated to have both jobs running in parallel instead of just having one so this can be evaluated.
Tell what you guys think.

@vpereira01 vpereira01 marked this pull request as ready for review March 25, 2022 12:53
afonsojramos
afonsojramos previously approved these changes Mar 25, 2022
Copy link
Collaborator

@afonsojramos afonsojramos left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Overall I think it looks good! It caught a lot of things that we didn't before, lets ship it! 🚀

We'll just need to fix these errors that we are getting such as:

.github/dependabot.yml Show resolved Hide resolved
@afonsojramos afonsojramos added the ✨ enhancement New feature or request label Mar 25, 2022
Replaced awesome-bot validation to lychee-action to improve stability
and validation quality.
Added dependabot rule to keep improving validation.
@afonsojramos
Copy link
Collaborator

afonsojramos commented Apr 20, 2022

@marmelo can you approve this? 👀

PS: Maybe we should reduce the number of approvals to 1

@marmelo
Copy link
Owner

marmelo commented Apr 22, 2022

Lets try if this is better than awesome_bot. 👍

@vpereira01 vpereira01 merged commit 6c7c202 into marmelo:master Apr 22, 2022
@vpereira01 vpereira01 deleted the betterlinkvalidation branch January 8, 2024 18:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
✨ enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants