+
Skip to content

ExternalLinks are broken in documentation #41491

@mabartos

Description

@mabartos

Before reporting an issue

  • I have read and understood the above terms for submitting issues, and I understand that my issue may be closed without action if I do not follow them.

Area

docs

Describe the bug

The documentation checks are not executed very often and when they're finally executed, they contains some wrong links.

We should also find some way on how to at least test it on a nightly basis. EDIT: It is tested on a nightly basis, but no tests executed - see below.

Error:  Failures: 
Error:    ExternalLinksTest.checkExternalLinks:41 Broken links (3) in guide 'release_notes': 
		- file:/home/runner/work/keycloak/keycloak/docs/documentation/server_admin/target/generated-docs/index.html#_recovery-codes (invalid anchor _recovery-codes)
		- https://www.wildfly.org/news/2021/12/16/WildFly26-Final-Released/ (invalid redirect to )
		- https://www.wildfly.org/news/2021/10/05/WildFly25-Final-Released/ (invalid redirect to )
Error:    ExternalLinksTest.checkExternalLinks:41 Broken links (1) in guide 'server_admin': 
		- https://jwt.io/ (invalid redirect to https://www.jwt.io/)
Error:    ExternalLinksTest.checkExternalLinks:41 Broken links (2) in guide 'upgrading': 
		- file:/home/runner/work/keycloak/keycloak/docs/documentation/server_admin/target/generated-docs/index.html#_recovery-codes (invalid anchor _recovery-codes)
		- https://www.wildfly.org/news/2021/10/05/WildFly25-Final-Released/ (invalid redirect to )

It seems these tests are completely broken:
https://github.com/keycloak/keycloak/actions/runs/16545359256/job/46792168455

[INFO] -------------------------------------------------------
[INFO]  T E S T S
[INFO] -------------------------------------------------------
Jul 28, 2025 12:25:39 AM org.junit.platform.launcher.core.DefaultLauncher handleThrowable
WARNING: TestEngine with ID 'junit-jupiter' failed to discover tests
org.junit.platform.commons.JUnitException: OutputDirectoryProvider not available; probably due to unaligned versions of the junit-platform-engine and junit-platform-launcher jars on the classpath/module path.
	at org.junit.platform.engine.EngineDiscoveryRequest.getOutputDirectoryProvider(EngineDiscoveryRequest.java:94)
	at org.junit.jupiter.engine.JupiterTestEngine.discover(JupiterTestEngine.java:68)
	at org.junit.platform.launcher.core.DefaultLauncher.discoverEngineRoot(DefaultLauncher.java:168)
	at org.junit.platform.launcher.core.DefaultLauncher.discoverRoot(DefaultLauncher.java:155)
	at org.junit.platform.launcher.core.DefaultLauncher.discover(DefaultLauncher.java:120)
	at org.apache.maven.surefire.junitplatform.TestPlanScannerFilter.accept(TestPlanScannerFilter.java:56)
	at org.apache.maven.surefire.util.DefaultScanResult.applyFilter(DefaultScanResult.java:102)
	at org.apache.maven.surefire.junitplatform.JUnitPlatformProvider.scanClasspath(JUnitPlatformProvider.java:143)
	at org.apache.maven.surefire.junitplatform.JUnitPlatformProvider.invoke(JUnitPlatformProvider.java:124)
	at org.apache.maven.surefire.booter.ForkedBooter.invokeProviderInSameClassLoader(ForkedBooter.java:384)
	at org.apache.maven.surefire.booter.ForkedBooter.runSuitesInProcess(ForkedBooter.java:345)
	at org.apache.maven.surefire.booter.ForkedBooter.execute(ForkedBooter.java:126)
	at org.apache.maven.surefire.booter.ForkedBooter.main(ForkedBooter.java:418)

We need to include the enhancement for the maven surefire plugin: #41488

Version

main

Regression

  • The issue is a regression

Expected behavior

Tests pass

Actual behavior

Tests fail

How to Reproduce?

Run the test

Anything else?

No response

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions

    点击 这是indexloc提供的php浏览器服务,不要输入任何密码和下载