-
-
Notifications
You must be signed in to change notification settings - Fork 8.1k
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
[Tests] Add markdown-link-check on Travis CI #1656
Conversation
This uses the npm package `markdown-link-check` to check if all the links in the documentation are alive.
Since markdown-link-check hasn't support relative links, to make the test passed, move this link to use absolute URL so that we can introduce the new test. cc tcort/markdown-link-check#10
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This seems like it will actually hit the internet every time tests are run. What happens if the internet connection is flaky?
I'm not sure this is a particularly valuable addition; how often to links go down? If a link goes down and a human doesn't notice it, does it matter?
As the tests are on Travis CI, not a pure local test, so the Internet should be up everytime, or other tests may also failed, at least Travis CI needs to clone I wouldn't say the test is for a seldom appears issues but it can help us maintain all the links in the documentation always be available, in case one day any of them dead, which is very bad for user experience, it's just help us keep part of the documentation quality so I think it worth, we didn't have much effort on this test. |
We already have issues with test flakiness contacting iojs.org and, more rarely, nodejs.org - I'd rather not increase the chance of false failures. I'm not really concerned with a link not working - someone can always use archive.org, or file an issue and we'll correct it. URLs disappearing is a very rare event; cool URLs don't change. |
b76c5ea
to
7b530ed
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I've rebased this, with a more efficient files approach (git ls-files
over find
).
However, I got a 429 from github when running locally, and 2 working links were reported as failing.
I'm going to remove the CI integration and just land the script; we can look into making it robust in the future.
This test use the npm package: markdown-link-check to help check if all the links in the documentation is alive.
Since markdown-link-check hasn't support relative links, to make the test passed, move this link to use absolute URL so that we can introduce the new test. cc tcort/markdown-link-check#10