Introduce GitHub Action to test resolvability of external links [DOC-253] #1382
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
✅ Deploy Preview for hardcore-allen-f5257d ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
JackPGreen
force-pushed
the
check-external-links
branch
2 times, most recently
from
8e7bdb9 to
d21876c
Compare
JackPGreen
force-pushed
the
check-external-links
branch
from
d21876c to
9f08bc4
Compare
JackPGreen
force-pushed
the
check-external-links
branch
from
9f08bc4 to
1f0d755
Compare
JackPGreen
requested review from
oliverhowell,
amandalindsay and
Rob-Hazelcast
as code owners
JackPGreen
changed the title
fantkolja
reviewed
Nov 19, 2024
Fixed with workaround - 7a78108 Updated output - https://github.com/hazelcast/hz-docs/actions/runs/11907767488 |
fantkolja
approved these changes
Nov 19, 2024
JackPGreen
added a commit
that referenced
this pull request
Nov 25, 2024
|
Suggestion was to notify put on a cron schedule and have it notify a private @oliverhowell if you can send me a Slack webhook url for that channel I can do the rest. |
oliverhowell
approved these changes
Dec 9, 2024
JackPGreen
added a commit
to JackPGreen/hz-docs
that referenced
this pull request
Dec 19, 2024
The test developed in hazelcast#1382 flagged multiple dead links. This PR fixes those _seperately_ to prove the status of the test. Note the changes from `install-hazelcast.adoc` ~~copy from~~ overlap with hazelcast#1355.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This PR adds an action that will, when a PR is opened, check the resolvability of any external links.
External links are defined as those using the
httpscheme - internal links between documentation is already covered by our existing dead links check.Action is deliberately modular to be be easily applied to other docs repos.
This runs whenever a PR is raised, which is sub-optimal because:
But the other alternative - a scheduled check - would have difficulty in knowing who to target a failure communication at to resolve the issues (other projects notify Slack channels, with varying degrees of responses).
An example of the output produced by this action can be found here.
Note that the external link check fails because of dead links, and won't pass until the following are addressed:
URL 'https://raw.github.com/olivernn/lunr.js/master/lunr.min.js' had status 404 (found in node_modules/lunr/index.html)We should consider whether adding a check that we know will fail is a good idea - comparing the annoyance of a failing (non-blocking) test against the coverage that at least we can ensure things don't get worse.
Fixes: DOC-253