Skip to content

Validate and update links (STF-557)#387

Open
oschwald wants to merge 2 commits into
mainfrom
greg/stf-557
Open

Validate and update links (STF-557)#387
oschwald wants to merge 2 commits into
mainfrom
greg/stf-557

Conversation

@oschwald
Copy link
Copy Markdown
Member

@oschwald oschwald commented Jun 4, 2026

Add a lychee link-checker config (lychee.toml) and a
CI workflow (.github/workflows/links.yml), and fix stale/redirecting links
surfaced by running it.

The config mirrors the shared MaxMind setup: max_redirects = 0 so moved links
are surfaced, 500..=599 accepted so transient server errors don't fail CI, XML
namespace identifiers and the japicmp baseline-version placeholder excluded as
false positives, and the target/ build dir plus the src/test/resources/
MaxMind-DB submodule fixtures excluded from scanning.

Links updated (old -> new):

  • http://dev.maxmind.com/ -> https://dev.maxmind.com/ (pom.xml)
  • http://www.apache.org/licenses/LICENSE-2.0.html -> https://www.apache.org/licenses/LICENSE-2.0.html (pom.xml)
  • http://www.maxmind.com/ -> https://www.maxmind.com/en/home (pom.xml)
  • https://www.maxmind.com/en/support -> https://support.maxmind.com/knowledge-base (README.md, UPGRADING.md)

After the fixes, lychee reports: 28 Total, 21 OK, 0 Errors, 7 Excluded.

Part of STF-557.

🤖 Generated with Claude Code

Comment thread .github/workflows/links.yml Fixed
Copy link
Copy Markdown

@gemini-code-assist gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request introduces the Lychee link checker configuration (lychee.toml), adds .lycheecache to .gitignore, and updates various outdated or non-HTTPS URLs across README.md, UPGRADING.md, and pom.xml. The review feedback suggests minor improvements to the Lychee configuration, specifically anchoring a URL exclusion pattern with ^ for consistency and expanding the localhost exclusion pattern to support both HTTP and HTTPS.

Important

The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.

Comment thread lychee.toml
'^https://sandbox\.maxmind\.com',
'^https://updates\.maxmind\.com',
'^https://www\.maxmind\.com/en/accounts/',
'https://www\.maxmind\.com/en/account/login',
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

For consistency with the other URL patterns in the exclude list, and to prevent accidental partial matches, consider anchoring this pattern with ^.

Suggested change
'https://www\.maxmind\.com/en/account/login',
'^https://www\.maxmind\.com/en/account/login',

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These exclude entries are matched against full URLs, so a leading ^ is effectively a no-op here. Left as-is to match the dev-site/blog-site config style.

— Claude (posted on Greg's behalf)

Comment thread lychee.toml
'japicmp\.baselineVersion',
# Placeholders / local
'^https?://example\.(com|org|net)',
'^http://localhost',
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

To support both HTTP and HTTPS for local development links (e.g., https://localhost), consider using ^https?://localhost instead of ^http://localhost.

Suggested change
'^http://localhost',
'^https?://localhost',

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

localhost only appears as an http:// placeholder in this repo, so this is a no-op today; kept to match the shared template. Happy to broaden to https? if desired.

— Claude (posted on Greg's behalf)

@oschwald oschwald force-pushed the greg/stf-557 branch 2 times, most recently from dda00f0 to 0a57c29 Compare June 4, 2026 20:36
oschwald and others added 2 commits June 4, 2026 22:01
Part of STF-557.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

2 participants