生成groovydoc而不使用Gradle编译Groovy源

Question

我正在尝试从一些常规代码生成文档，但是Gradle失败，因为在尝试编译代码时它无法导入依赖项。这是可以预期的，因为在这些依赖项可用之前，代码需要在特定的上下文中运行。我不知道为什么它似乎只在解析源代码以提取文档时才尝试编译代码，但这是一个附带问题。

我的build.gradle：

apply plugin: 'groovy'

repositories {
    mavenCentral();
}

dependencies {
    compile 'org.codehaus.groovy:groovy-all:2.4.5'
}


sourceSets {
    main {
        groovy {
            srcDirs = ['src/org/mysource']
        }
    }
}

我在exclude和groovyCompile任务中都尝试过诸如CompileGroovy之类的各种事情，但这没什么区别。我无法在这种情况下提供依赖项。欢迎其他建议。凡是能够找到使用asciidoc记录常规文件的可行解决方案的人都可以得到加分，这也是我未能实现的。

Answer 1

在运行:compileGroovy任务时，有两个选项可以禁用groovydoc。首先是一个简短的例子。我有一个Groovy Gradle项目，在其中引入了一些更改，使其编译失败：

gradle groovydoc

输出：

> Task :compileGroovy FAILED
startup failed:
/home/wololock/workspace/upwork/jenkins-continuous-delivery-pipeline/src/com/upwork/util/MapUtils.groovy: 29: [Static type checking] - Cannot find matching method com.upwork.util.MapUtils#merge(V, java.lang.Object). Please check if the declared type is right and if the method exists.
 @ line 29, column 56.
    = result[k] instanceof Map ? merge(resu
                                 ^
1 error

FAILURE: Build failed with an exception.

* What went wrong:
Execution failed for task ':compileGroovy'.
> Compilation failed; see the compiler error output for details.

* Try:
Run with --stacktrace option to get the stack trace. Run with --info or --debug option to get more log output. Run with --scan to get full insights.

* Get more help at https://help.gradle.org

BUILD FAILED in 4s
1 actionable task: 1 executed

现在，让我们仔细看看一个选项，这些选项使我无需编译此源代码即可生成groovydoc。

1。从命令行禁用compileGroovy

当您运行-x Gradle任务时，可以使用compileGroovy开关禁用groovydoc：

gradle clean groovydoc -x compileGroovy

输出：

> Task :groovydoc 
Trying to override old definition of task fileScanner

BUILD SUCCESSFUL in 2s
2 actionable tasks: 2 executed

2。在compileGroovy

中禁用build.gradle

如果您不想使用-x开关，并且希望在运行compileGroovy时禁用groovydoc任务，则可以通过修改任务图来禁用compileGroovy在build.gradle中：

gradle.taskGraph.whenReady { graph ->
  if (graph.hasTask(':groovydoc')) {
    compileGroovy.enabled = false
  }
}

只需将其添加到build.gradle文件中的某个位置即可。现在，当您执行时：

gradle groovydoc

任务compileGroovy将被禁用，源代码也不会得到编译。

> Task :groovydoc 
Trying to override old definition of task fileScanner

BUILD SUCCESSFUL in 2s
2 actionable tasks: 2 executed