fix: cleanup doc build so it doesn't block the entire build

Author: jdaugherty

grails-doc/build.gradle

@@ -19,7 +19,7 @@
 
 import grails.doc.git.FetchTagsTask
 import grails.doc.dropdown.CreateReleaseDropDownTask
-import grails.doc.gradle.PublishGuide
+import grails.doc.gradle.PublishGuideTask
 
 plugins {
     id 'base'
@@ -67,30 +67,30 @@ combinedGroovydoc.configure { Groovydoc gdoc ->
             .findAll { it.findProperty('includeInApiDocs') }
 
     def sources = docProjects
-            .collectMany {Project it ->
+            .collectMany { Project it ->
                 List possibleSources = [it.sourceSets.main]
 
                 def testFixturesSource = it.sourceSets.findByName('testFixtures')
-                if(testFixturesSource) {
+                if (testFixturesSource) {
                     possibleSources.add(testFixturesSource)
                 }
 
                 def astSource = it.sourceSets.findByName('ast')
-                if(astSource) {
+                if (astSource) {
                     possibleSources.add(astSource)
                 }
                 possibleSources
             }
             .flatten()
-    gdoc.source(sources.collect{ SourceSet it -> [it.allSource.srcDirs, it.allSource.srcDirs] }.flatten().findAll { File srcDir ->
-        if(!(srcDir.name in ['java', 'groovy'])) {
+    gdoc.source(sources.collect { SourceSet it -> [it.allSource.srcDirs, it.allSource.srcDirs] }.flatten().findAll { File srcDir ->
+        if (!(srcDir.name in ['java', 'groovy'])) {
             return false
         }
 
         srcDir.exists()
     }.unique())
 
-    gdoc.classpath = files(sources.collect{ SourceSet it -> it.compileClasspath.filter(File.&isDirectory) }.flatten().unique())
+    gdoc.classpath = files(sources.collect { SourceSet it -> it.compileClasspath.filter(File.&isDirectory) }.flatten().unique())
     gdoc.destinationDir = project.layout.buildDirectory.dir('combined-api/api').get().asFile
 
     gdoc.inputs.files(gdoc.source)
@@ -102,68 +102,54 @@ System.setProperty('grails.docs.clean.html', 'true')
 // creates single.html.before.xml and single.html.after.xml files for debugging pdf input when enabled
 //System.setProperty('grails.docs.debug.pdf','true')
 
-asciidoctor {
-    resources {
-        from('resources')
-    }
-
-    options template_dirs: ["${projectDir}/src/docs/templates"]
-    attributes 'experimental': 'true',
-            'compat-mode': 'true',
-            'icons': 'font',
-            'linkcss': 'true',
-            'docinfo1': '',
-            'toc': 'left',
-            'version': project.version,
-            'sourcedir': rootProject.projectDir.absolutePath
-}
-
-asciidoctor.dependsOn('aggregateGroovydoc')
-
-tasks.register('dist', Zip).configure { Zip it ->
-    it.dependsOn 'docs'
-    it.from outputDir
-}
-
-tasks.register('fetchTags', FetchTagsTask)
-
-tasks.register('createReleaseDropdown', CreateReleaseDropDownTask).configure { CreateReleaseDropDownTask it ->
-    it.group = 'documentation'
-    it.dependsOn 'publishGuide'
-
-    it.inputFiles = project.layout.buildDirectory.files('modified-guide/guide/single.html', 'modified-guide/index.html')
-    it.docsDirectory = project.layout.buildDirectory.dir('original-guide')
-    it.outputDir = project.layout.buildDirectory.dir('modified-guide')
-}
-
-tasks.register('resolveGroovyVersion').configure { Task versionTask ->
-    versionTask.group = 'documentation'
-    versionTask.description = 'Resolve Groovy Version from the BOM'
-    ext.resolved = configurations.compileClasspath
-            .resolvedConfiguration
-            .resolvedArtifacts
-            .find {
-                it.moduleVersion.id.group == 'org.apache.groovy' &&
-                        it.moduleVersion.id.name.contains('groovy')
-            }.moduleVersion.id.version
-    logger.lifecycle('Resolved Groovy version for Guide links: {}', ext.resolved)
-}
-
 String getVersion(String artifact) {
     String version = configurations.runtimeClasspath
             .resolvedConfiguration
             .resolvedArtifacts
             .find {
                 it.moduleVersion.id.name == artifact
             }?.moduleVersion?.id?.version
-    if(!version) {
+    if (!version) {
         throw new GradleException("Could not find ${artifact} version.")
     }
     version
 }
 
-tasks.register('publishGuide', PublishGuide).configure { PublishGuide publish ->
-    publish.dependsOn(['generateBomDocumentation', 'aggregateGroovydoc', 'jar', 'resolveGroovyVersion', 'processTestResources', 'compileTestJava', 'compileTestGroovy', 'test'])
+def generateBomDocumentation = tasks.register('generateBomDocumentation')
+generateBomDocumentation.configure { Task it ->
+    it.dependsOn(':grails-bom:extractConstraints')
+
+    it.description = 'Generates an AsciiDoc table listing Group, Artifact, and Version for project dependencies.'
+    it.group = 'documentation'
+
+    it.inputs.files(project(':grails-bom').layout.projectDirectory.asFileTree)
+    it.outputs.file(project.layout.projectDirectory.file('src/en/ref/Versions/Grails BOM.adoc'))
+
+    def versionsDir = project.layout.projectDirectory.dir('src/en/ref/Versions')
+    it.doFirst {
+        versionsDir.asFile.mkdirs()
+    }
+
+    def bomDocumentFile = project.layout.projectDirectory.file('src/en/ref/Versions/Grails BOM.adoc')
+    def grailsBomConstraintFile = project(':grails-bom').layout.buildDirectory.file('grails-bom-constraints.adoc')
+    it.doLast {
+        def bomDocument = bomDocumentFile.asFile
+        bomDocument.withWriter { writer ->
+            writer.writeLine '== Grails BOM Dependencies'
+            writer.writeLine ''
+            writer.writeLine 'This document provides information about the dependencies defined in the Grails BOM - also known as `org.apache.grails:grails-bom`. It includes the artifact coordinates, where in the hierarchy the coordinate was defined, and the maven property that defines the version.'
+            writer.writeLine ''
+            writer.write(grailsBomConstraintFile.get().asFile.text)
+            writer.writeLine ''
+        }
+
+        it.logger.lifecycle "BOM Dependency Page generated to: ${bomDocument.absolutePath}"
+    }
+}
+
+def publishGuideTask = tasks.register('publishGuide', PublishGuideTask)
+publishGuideTask.configure { PublishGuideTask publish ->
+    publish.dependsOn([generateBomDocumentation])
 
     // No language setting because we want the English guide to be
     // generated with a 'en' in the path, but the source is in 'en'
@@ -178,15 +164,15 @@ tasks.register('publishGuide', PublishGuide).configure { PublishGuide publish ->
     publish.properties = project.provider {
         def springVersion = getVersion('spring-core')
         def springBootVersion = getVersion('spring-boot')
-
+        def groovyVersion = getVersion('groovy') as String
         [
                 'api'                      : '../api',
                 'safe'                     : 'UNSAFE', // Make sure any asciidoc security is disabled
                 'jakartaee'                : 'https://jakarta.ee/specifications/platform/10/apidocs/',
                 'javase'                   : "https://docs.oracle.com/en/java/javase/${javaVersion}/docs/api/",
-                'groovyapi'                : "https://docs.groovy-lang.org/${resolveGroovyVersion.resolved}/html/gapi/",
-                'groovyjdk'                : "https://docs.groovy-lang.org/${resolveGroovyVersion.resolved}/html/groovy-jdk/",
-                'groovyVersion'            : resolveGroovyVersion.resolved,
+                'groovyapi'                : "https://docs.groovy-lang.org/${groovyVersion}/html/gapi/",
+                'groovyjdk'                : "https://docs.groovy-lang.org/${groovyVersion}/html/groovy-jdk/",
+                'groovyVersion'            : groovyVersion,
                 'springapi'                : "https://docs.spring.io/spring/docs/${springVersion}/javadoc-api/",
                 'springdocs'               : "https://docs.spring.io/spring/docs/${springVersion}/",
                 'githubBranch'             : githubBranch,
@@ -219,44 +205,23 @@ tasks.register('publishGuide', PublishGuide).configure { PublishGuide publish ->
     }
 }
 
-tasks.register('generateBomDocumentation').configure { Task it ->
-    it.dependsOn(':grails-bom:extractConstraints')
-
-    it.description = 'Generates an AsciiDoc table listing Group, Artifact, and Version for project dependencies.'
-    it.group = 'documentation'
-
-    it.inputs.files(project(':grails-bom').layout.projectDirectory.asFileTree)
-    it.outputs.file(project.layout.projectDirectory.file('src/en/ref/Versions/Grails BOM.adoc'))
+def createReleaseDropdownTask = tasks.register('createReleaseDropdown', CreateReleaseDropDownTask)
+createReleaseDropdownTask.configure { CreateReleaseDropDownTask it ->
+    it.dependsOn(publishGuideTask)
 
-    def versionsDir = project.layout.projectDirectory.dir('src/en/ref/Versions')
-    it.doFirst {
-        versionsDir.asFile.mkdirs()
-    }
-
-    def bomDocumentFile = project.layout.projectDirectory.file('src/en/ref/Versions/Grails BOM.adoc')
-    def grailsBomConstraintFile = project(':grails-bom').layout.buildDirectory.file('grails-bom-constraints.adoc')
-    it.doLast {
-        def bomDocument = bomDocumentFile.asFile
-        bomDocument.withWriter { writer ->
-            writer.writeLine '== Grails BOM Dependencies'
-            writer.writeLine ''
-            writer.writeLine 'This document provides information about the dependencies defined in the Grails BOM - also known as `org.apache.grails:grails-bom`. It includes the artifact coordinates, where in the hierarchy the coordinate was defined, and the maven property that defines the version.'
-            writer.writeLine ''
-            writer.write(grailsBomConstraintFile.get().asFile.text)
-            writer.writeLine ''
-        }
-
-        it.logger.lifecycle "BOM Dependency Page generated to: ${bomDocument.absolutePath}"
-    }
+    it.filesToAddDropdowns = project.layout.buildDirectory.files('modified-guide/guide/single.html', 'modified-guide/index.html')
+    it.sourceDocsDirectory = project.layout.buildDirectory.dir('original-guide')
+    it.modifiedPagesDirectory = project.layout.buildDirectory.dir('modified-guide')
 }
 
-tasks.register('generateGuide').configure { Task task ->
-    task.dependsOn('createReleaseDropdown')
-    task.group = 'documentation'
+def fetchTagsTask = project.tasks.register('fetchTags', FetchTagsTask)
+createReleaseDropdownTask.configure {
+    dependsOn(fetchTagsTask)
 }
 
-tasks.register('docs', Sync).configure { Sync it ->
-    it.dependsOn 'aggregateGroovydoc', 'generateGuide', ':grails-data-docs-stage:docs'
+def docsTask = tasks.register('docs', Sync)
+docsTask.configure { Sync it ->
+    it.dependsOn(combinedGroovydoc, createReleaseDropdownTask, ':grails-data-docs-stage:docs')
     it.group = 'documentation'
 
     def manualDocsDir = project.layout.buildDirectory.dir('modified-guide')
@@ -276,6 +241,11 @@ tasks.register('docs', Sync).configure { Sync it ->
     it.into mergedDocsDir
 }
 
+tasks.register('dist', Zip).configure { Zip it ->
+    it.dependsOn(docsTask)
+    it.from(outputDir)
+}
+
 artifacts {
     archives dist
 }