Add external link checking - #2697
Draft
holly-cummins wants to merge 11 commits into
Draft
Conversation
holly-cummins
marked this pull request as draft
June 10, 2026 20:30
holly-cummins
force-pushed
the
add-external-link-checking
branch
2 times, most recently
from
June 11, 2026 09:26
c6a25f1 to
f9c14c3
Compare
|
🎊 PR Preview 3ee7761 has been successfully built and deployed to https://quarkus-website-pr-2697-preview.surge.sh
|
holly-cummins
force-pushed
the
add-external-link-checking
branch
from
June 11, 2026 09:48
f9c14c3 to
c1c224d
Compare
This was referenced Jun 11, 2026
Closed
holly-cummins
force-pushed
the
add-external-link-checking
branch
from
June 15, 2026 16:32
c386a65 to
ed064fd
Compare
# Conflicts: # src/test/java/io/quarkusio/LinkCrawlerTest.java
Two-phase link checker: Phase 1 crawls internal pages with Playwright, Phase 2 checks collected external URLs with plain HTTP. Per-domain rate limiting (Semaphore(2)), exponential backoff (5 retries), HEAD→GET→no-UA fallback for bot-blocking sites. Placeholder/template URL detection, do-not-check list for hostile sites, "such as" context filtering. GitHub Actions workflow runs on schedule and on PRs to checker code (dry-run mode for PRs). JBang script files issues with dead-link label and area/documentation for guide pages, with instructions on how to handle false positives. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
…le URLs, show count in summary Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
… 403/405 lists Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
holly-cummins
force-pushed
the
add-external-link-checking
branch
from
June 22, 2026 11:13
ed064fd to
2591ddb
Compare
Many old tweets have been deleted, and Twitter/X blocks bot requests, so most checks return 404 regardless of actual page status. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Resolves merge conflicts in .gitignore and LinkCrawlerTest.java, combining the PR's two-phase external link checking (domain semaphores, rate limiting, DO_NOT_CHECK list, "such as" filtering, results JSON output) with upstream's image checking support. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Add nip.io, cluster.local, and ocp.host to EXAMPLE_HOSTS so the link crawler skips URLs like *.127.0.0.1.nip.io, Kubernetes cluster-internal addresses, and OpenShift example hostnames that appear in guide documentation. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Newsletters are point-in-time link roundups whose external links naturally go stale. Checking old issues generates noise without actionable fixes. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Old posts contain external links that naturally go stale over time and are rarely updated, so broken links in them are not actionable. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
The exclusion only prevented crawling blog pages but the same dead links were still found via publications and other pages, so it did not meaningfully reduce the broken link count. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Resolves #2110
Draft, because there are still too many dead links. Raising issues for all of them would create too much noise, and instead the job refuses and fails.
Did you know we have 4,700 pages in the site, which contain 17,973 external links checked?
External links can go AWOL for all sorts of external reasons, so we don't want to block PRs for them. However, we do want to discover them when they happen. The best way to do this is to run a scheduled job and raise defects. This is what we currently do on the extensions site. The length of the job is a bit of a challenge, and false positives caused by bot-blockers is a bigger challenge. Usually I work around that by just having a 'do not check' list, so I've used that pattern here. I've also excluded obvious placeholder links like myserver.com, and links which are in a sentence following "such as", such as "a url such as http://plausible.com".
The link checker will run in dry run mode for PR changes which directly affect the link checker (like this one), and otherwise it will run as a scheduled job and raise defects. I don't know if the default token will be good enough to raise guide defects in quarkus repo, but we will find out.