-
Notifications
You must be signed in to change notification settings - Fork 3.9k
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
Delete build-system/tasks/package.json, whitelist heroku page #13295
Delete build-system/tasks/package.json, whitelist heroku page #13295
Conversation
/to @erwinmombay @choumx |
/to @danielrozenberg |
@@ -143,6 +143,10 @@ function filterWhitelistedLinks(markdown) { | |||
// Links inside a <code> block (illustrative, and not always valid) | |||
filteredMarkdown = filteredMarkdown.replace(/<code>(.*?)<\/code>/g, ''); | |||
|
|||
// The heroku nightly build page is not always acccessible by the checker. | |||
filteredMarkdown = filteredMarkdown.replace( | |||
/\(http:\/\/amphtml-nightly.herokuapp.com\/\)/g, ''); |
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.
Replace http
with https?
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.
The original URL in DEVELOPING.md
is http
, so we must whitelist it that way. Also, I'm not sure that changing the original URL will make this less flaky, so I think whitelisting is the way to go. The check is meant to catch other broken links, due to defunct external sites, or bad relative links.
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.
https?
(question mark included) means it'll catch both http
and https
, in case someone changes the documentation later :)
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.
Aha! Right now, we only have the one place where we document the URL, so I'll keep it this way for simplicity.
This PR contains two
gulp check-links
fixes:build-system/tasks/package.json
is superfluous, since the only dependency it contains already exists inampproject/amphtml/package.json
. The file was added in Add a PR check test to catch dead links during docs changes #9099, back when I didn't know what I was doing :)http://amphtml-nightly.herokuapp.com/
, resulting in several failed builds on Travis. Since this is a well known page that's unlikely to ever be a truly dead link, we whitelist it duringgulp check-links
.