-
-
Notifications
You must be signed in to change notification settings - Fork 9.6k
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
workflows/docs: Check for broken links using the existing rake test
task
#15924
Conversation
This gem needs Ruby 3. |
51a1ca2
to
7bf7839
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.
Great idea!
- We had `rake test` as a task, but we never actually ran it in CI or anywhere before building the site. - The `html-proofer` gem [only supports Ruby 3.1](https://github.com/gjtorikian/html-proofer/blob/main/html-proofer.gemspec#L20), so I bumped the linting job to use Ruby 3.1 across the board. - This will make things slower (or maybe it's taking ages because of my dodgy hotel internet connection), maybe we should only run it on a schedule as a separate job? - Fixes https://github.com/Homebrew/brew/issues/ 15908.
- It reports a lot of broken internal links that do actually exist, it's just file extension inference weirdness.
87ddba9
to
1c91da2
Compare
2013ca5
to
210b678
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.
Great work!
], | ||
cache: { | ||
timeframe: { | ||
external: "1h" |
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.
@issyl0 does this setup the GitHub Actions cache across workflows? If not, might be a nice extension.
brew style
with your changes locally?brew typecheck
with your changes locally?brew tests
with your changes locally?rake test
as a task that useshtml-proofer
to scan for broken links, but we never actually ran it in CI or anywhere before building the site.