Skip to content

Pin links to user guide in javadoc to specific version #5290

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
JINU-CHANG wants to merge 6 commits into
base: main
Choose a base branch
from
+23 −0
Open

Pin links to user guide in javadoc to specific version #5290

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
966a345
change link to user guide to specific version
JINU-CHANG Jan 28, 2026
c40a316
Merge remote-tracking branch 'origin/main' into issue-5273-fix-javado…
mpkorstanje Jan 28, 2026
1cb1389
Polish contribution
mpkorstanje Jan 28, 2026
a75a573
restore code that changes user guide links to specific version in eac…
JINU-CHANG Feb 2, 2026
c302a93
revert incorrect code change
JINU-CHANG Feb 2, 2026
d935857
extract link into a targetUrl variable
JINU-CHANG Feb 2, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions documentation/documentation.gradle.kts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -390,11 +390,19 @@ tasks {
<link rel="icon" type="image/png" href="https://junit.org/assets/img/junit-diamond.png">
<link rel="icon" type="image/svg+xml" href="https://junit.org/assets/img/junit-diamond-adaptive.svg" sizes="any">
""".trimIndent()

val version = project.version.toString().replace("-SNAPSHOT", "")
val versionedDocsPathOrUrl = if (System.getenv("CI") == "true") "https://docs.junit.org/$version"
else layout.buildDirectory.dir("antora-site").get().asFile.toURI().resolve(version).toString()

filter { line ->
var result = if (line.startsWith("<head>")) line.replace("<head>", "<head>$favicon") else line
externalModulesWithoutModularJavadoc.forEach { (moduleName, baseUrl) ->
result = result.replace("${baseUrl}$moduleName/", baseUrl)
}

result = result.replace("https://docs.junit.org/current", versionedDocsPathOrUrl)

return@filter result
}
}
Expand Down
15 changes: 15 additions & 0 deletions gradle/plugins/common/src/main/kotlin/junitbuild.javadoc-conventions.gradle.kts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,21 @@ tasks.javadoc {
noTimestamp(true)
}
}

doLast {
val version = project.version.toString().replace("-SNAPSHOT", "")
val targetUrl = "https://docs.junit.org/current"

destinationDir?.walkTopDown()
?.filter { it.extension == "html" }
?.forEach { file ->
val content = file.readText()
if (content.contains(targetUrl)) {
val updatedContent = content.replace(targetUrl, "https://docs.junit.org/$version")
file.writeText(updatedContent)
}
}
}
}

tasks.named<Jar>("javadocJar").configure {
Expand Down