jenkins - 如何从 jenkins 全局库生成 groovydoc

Question

我有一个 jenkins global library我想记录下来。我想使用 groovydoc。

该库包含类和全局变量

src/<package-name>
vars

为类生成文档没有问题:

groovydoc -sourcepath src -d doc 'main.pipeline' '*.groovy'

但是如何为 vars 生成文档？

Answer 1

为了确保所有内容都在正确的包中报告，而不必枚举所有包，我使用了:

mkdir -p doc/

groovydoc -d doc -private -nomainforscripts -sourcepath src:vars \
    $(find src/ vars/ -name \*.groovy -printf '%P\n')

这个咒语说服 Groovydoc 获得正确的包，而无需我冗长地列出所有包，这是主要的挑战。

如果您的 find没有 -printf , 替换 -printf '%P\n'与 | cut -d '/' -f 2- .效果是一样的；剥离领先 src/或 vars/ .