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

chore(ci): checks for broken links #460

Merged
merged 5 commits into from
May 3, 2021
Merged

Conversation

EverlastingBugstopper
Copy link
Contributor

@EverlastingBugstopper EverlastingBugstopper commented Apr 20, 2021

fixes #444 - also includes some fixes for broken links that it found already 😄

note: there is an option to only include files that were changed in the PR that was pushed. we could combo that config option with a daily cron that checks the whole repo for broken links.

fine with the current approach since that's what we talked about in triage but wanted to let folks know of that option :)


i've opened this issue to see if there is a way to exclude our nested node_modules directories from the ambitious link checker

Comment on lines 44 to 45
use-quiet-mode: 'yes'
use-verbose-mode: 'yes'
Copy link
Contributor Author

@EverlastingBugstopper EverlastingBugstopper Apr 20, 2021

Choose a reason for hiding this comment

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

this combo seems weird at first, but what it does is:

  • only show us errors that occur instead of successful links AND errors
  • output full HTTP info for broken links

this config seems to be popular among other projects using this tool

Copy link
Member

@lrlna lrlna left a comment

Choose a reason for hiding this comment

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

I am fine with checking the whole repo for broken links, since a change in a given PR can affect links in parts of the repo that were untouched.

Thanks for thinking about this!!

@EverlastingBugstopper EverlastingBugstopper force-pushed the avery/check-links branch 3 times, most recently from 372644b to 7d20480 Compare May 3, 2021 17:08
@EverlastingBugstopper EverlastingBugstopper modified the milestones: Qx, May 11 - GA May 3, 2021
@EverlastingBugstopper EverlastingBugstopper merged commit dffa9c7 into main May 3, 2021
@EverlastingBugstopper EverlastingBugstopper deleted the avery/check-links branch May 3, 2021 17:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Consider checking for broken markdown links in CI
3 participants