Skip to content

Add external link checking#2697

Draft
holly-cummins wants to merge 5 commits into
quarkusio:mainfrom
holly-cummins:add-external-link-checking
Draft

Add external link checking#2697
holly-cummins wants to merge 5 commits into
quarkusio:mainfrom
holly-cummins:add-external-link-checking

Conversation

@holly-cummins

@holly-cummins holly-cummins commented Jun 10, 2026

Copy link
Copy Markdown
Contributor

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.

@holly-cummins holly-cummins marked this pull request as draft June 10, 2026 20:30
@holly-cummins holly-cummins force-pushed the add-external-link-checking branch 2 times, most recently from c6a25f1 to f9c14c3 Compare June 11, 2026 09:26
@github-actions

github-actions Bot commented Jun 11, 2026

Copy link
Copy Markdown

🎊 PR Preview 326a3d4 has been successfully built and deployed to https://quarkus-website-pr-2697-preview.surge.sh

  • Images of blog posts older than 3 months are not available.
  • Newsletters older than 3 months are not available.

holly-cummins and others added 5 commits June 22, 2026 12:13
# 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 holly-cummins force-pushed the add-external-link-checking branch from ed064fd to 2591ddb Compare June 22, 2026 11:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add dead link checker to CI

1 participant