(ofbiz-framework) branch trunk updated: Improved: javadoc no longer depends on docs.groovy-lang.org at build time (OFBIZ-13566)

[mridulpathak]

This is an automated email from the ASF dual-hosted git repository.

mridulpathak pushed a commit to branch trunk
in repository https://gitbox.apache.org/repos/asf/ofbiz-framework.git


The following commit(s) were added to refs/heads/trunk by this push:
     new fdf8263703 Improved: javadoc no longer depends on docs.groovy-lang.org 
at build time (OFBIZ-13566)
fdf8263703 is described below

commit fdf826370309773ded7e281036f6e78cf91482c3
Author: Mridul Pathak <mridul...@gmail.com>
AuthorDate: Tue Sep 8 15:32:09 2026 +0530

    Improved: javadoc no longer depends on docs.groovy-lang.org at build time 
(OFBIZ-13566)
    
    docs.groovy-lang.org is frequently unreachable, and since the javadoc task 
has failOnError set, a connection timeout there fails the whole task, which has 
been breaking trunk, release24.09, and PR builds alike. Switches to 
-linkoffline so the required element-list is read from a local copy extracted 
from Groovy's own javadoc jar instead of fetched live, while generated links 
still point at the real site. The version is pulled from 
libs.versions.groovy.all so a future Groovy bump keeps [...]
---
 build.gradle | 28 +++++++++++++++++++++++++++-
 1 file changed, 27 insertions(+), 1 deletion(-)

diff --git a/build.gradle b/build.gradle
index 2b3cdd0333..ba847603e9 100644
--- a/build.gradle
+++ b/build.gradle
@@ -152,9 +152,32 @@ distributions.main.contents.from(rootDir) {
     exclude '**/.gradle/**'
 }
 
+// docs.groovy-lang.org is frequently unreachable, failing :javadoc outright.
+// Extract element-list from Groovy's own javadoc jar so -linkoffline doesn't 
need
+// the network at build time; generated links still point at the real site.
+configurations {
+    groovyJavadocElements {
+        transitive = false // avoid also pulling in groovy's own javadoc jar
+    }
+}
+
+dependencies {
+    groovyJavadocElements 
"org.apache.groovy:groovy-all:${libs.versions.groovy.all.get()}:javadoc"
+}
+
+def groovyOfflineLinks = 
layout.buildDirectory.dir('javadoc/groovy-offline-package-list')
+
+tasks.register('extractGroovyElementList', Copy) {
+    from({ zipTree(configurations.groovyJavadocElements.singleFile) }) {
+        include 'element-list'
+    }
+    into groovyOfflineLinks
+}
+
 javadoc {
     title="OFBiz " + getCurrentGitBranch() + " API"
     failOnError = true
+    dependsOn extractGroovyElementList
     options {
         source '17'
         encoding 'UTF-8'
@@ -164,13 +187,16 @@ javadoc {
         links(
             'https://docs.oracle.com/en/java/javase/17/docs/api/',
             'https://tomcat.apache.org/tomcat-10.1-doc/servletapi/',
-            'https://docs.groovy-lang.org/docs/groovy-4.0.22/html/api',
             'https://commons.apache.org/proper/commons-cli/apidocs'
         )
     }
     options as StandardJavadocDocletOptions
     // Generate Javadocs quietly, validate everything except missing 
documentation
     options.addStringOption('Xdoclint:all,-missing', '-quiet')
+    options.linksOffline(
+        
"https://docs.groovy-lang.org/docs/groovy-${libs.versions.groovy.all.get()}/html/api/",
+        groovyOfflineLinks.get().asFile.path
+    )
 }
 
 java {