Merge pull request #15012 from apache/include-grails-gradle-groovydocs

Include sources from composite builds in Groovydoc

Author: jamesfredley

grails-doc/build.gradle

@@ -82,13 +82,34 @@ combinedGroovydoc.configure { Groovydoc gdoc ->
                 possibleSources
             }
             .flatten()
-    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())
+    List<File> baseSourceDirs = sources
+            .collect { SourceSet it -> it.allSource.srcDirs }
+            .flatten()
+            .findAll { File srcDir ->
+                if (!(srcDir.name in ['java', 'groovy'])) {
+                    return false
+                }
+                srcDir.exists()
+            }
+
+    // Collect source directories from included builds (composite builds)
+    // Gradle will not provide the included build projects or source sets, so we inspect the file system
+    List<File> includedBuildSourceDirs = gradle.includedBuilds
+            .collectMany { includedBuild ->
+                def sourceDirs = []
+                includedBuild.projectDir.eachDir { File dir ->
+                    ['src/main/java', 'src/main/groovy'].each { rel ->
+                        File sourceDir = new File(dir, rel)
+                        if (sourceDir.isDirectory()) {
+                            sourceDirs << sourceDir
+                        }
+                    }
+                }
+                sourceDirs
+            }
+
+    gdoc.source(project.files((baseSourceDirs + includedBuildSourceDirs).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

grails-doc/src/en/guide/plugins/understandingPluginLoadOrder.adoc

@@ -99,23 +99,14 @@ It's not only plugin load order that you can control. You can also specify which
 [source,groovy]
 ----
 def environments = ['development', 'test', 'myCustomEnv']
-def scopes = [excludes:'war']
 ----
 
-In this example, the plugin will only load in the 'development' and 'test' environments. Nor will it be packaged into the WAR file, because it's excluded from the 'war' phase. This allows `development-only` plugins to not be packaged for production use.
+In this example, the plugin will only load in the 'development', 'test' and 'myCustomEnv' environments.
 
-The full list of available scopes are defined by the enum link:{api}grails/util/BuildScope.html[BuildScope], but here's a summary:
-
-* `test` - when running tests
-* `functional-test` - when running functional tests
-* `run` - for run-app and run-war
-* `war` - when packaging the application as a WAR file
-* `all` - plugin applies to all scopes (default)
-
-Both properties can be one of:
+The properties can be one of:
 
 * a string - a sole inclusion
-* a list - a list of environments or scopes to include
+* a list - a list of environments to include
 * a map - for full control, with 'includes' and/or 'excludes' keys that can have string or list values
 
 For example,

grails-gradle/plugins/README.md

@@ -17,7 +17,7 @@ limitations under the License.
 Grails Gradle Plugins
 ========
 
-Latest API Docs: https://grails.github.io/grails-gradle-plugin/latest/api/
+Latest API Docs: https://docs.grails.org/latest/api/
 
 Below are the plugins that are provided by the grails-gradle-plugin dependency.