hazelcast / hz-docs

Source content for the Hazelcast Platform documentation
10 stars 97 forks source link

Introduce GitHub Action to test resolvability of external links [DOC-253] #1382

Open JackPGreen opened 4 days ago

JackPGreen commented 4 days ago

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 http scheme - 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:

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

netlify[bot] commented 4 days ago

Deploy Preview for hardcore-allen-f5257d ready!

Name Link
Latest commit 5dd0d4f54f177d55d8bc43fca0362f63c9007a6d
Latest deploy log https://app.netlify.com/sites/hardcore-allen-f5257d/deploys/6740bb22d1172d0008203f90
Deploy Preview https://deploy-preview-1382--hardcore-allen-f5257d.netlify.app
Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

JackPGreen commented 3 days ago

Very nice! The only thing - probably some URLs aren't properly parsed, so there are a lot of bad/illegal format or missing URL logs

Fixed with workaround - https://github.com/hazelcast/hz-docs/pull/1382/commits/7a781087b3e8f92b7bb55734c9b0bfded2b14fe7

Updated output - https://github.com/hazelcast/hz-docs/actions/runs/11907767488