workflows/docs: Check for broken links using the existing rake test task
#15924
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
This gem needs Ruby 3. |
issyl0
force-pushed
the
docs-ci-broken-links
branch
from
51a1ca2
to
7bf7839
Compare
- 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.
issyl0
force-pushed
the
docs-ci-broken-links
branch
from
87ddba9
to
1c91da2
Compare
issyl0
force-pushed
the
docs-ci-broken-links
branch
from
2013ca5
to
210b678
Compare
EricFromCanada
approved these changes
Sep 1, 2023
MikeMcQuaid
reviewed
Sep 1, 2023
| ], | ||
| cache: { | ||
| timeframe: { | ||
| external: "1h" |
There was a problem hiding this comment.
@issyl0 does this setup the GitHub Actions cache across workflows? If not, might be a nice extension.
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
brew stylewith your changes locally?brew typecheckwith your changes locally?brew testswith your changes locally?rake testas a task that useshtml-prooferto scan for broken links, but we never actually ran it in CI or anywhere before building the site.