2016-12-15 31 views
4

documentation,它应该是可能包括*.txt文件的帮助/文档:詹金斯管道:如何添加帮助全球共享库

(root) 
+- src      # Groovy source files 
| +- org 
|  +- foo 
|   +- Bar.groovy # for org.foo.Bar class 
+- vars 
| +- foo.groovy   # for global 'foo' variable/function 
| +- foo.txt    # help for 'foo' variable/function 
+- resources    # resource files (external libraries only) 
| +- org 
|  +- foo 
|   +- bar.json # static helper data for org.foo.Bar 

...

的瓦尔目录承载定义可从管道脚本访问的全局变量 的脚本。每个* .groovy文件 的基名应该是Groovy(〜Java)标识符,通常是camelCased。匹配* .txt的 (如果存在)可以包含文档,通过系统配置的标记格式化程序处理 (所以可能确实是 HTML,Markdown等,尽管需要txt扩展名)。

不幸的是,它并没有为我工作,只需创建*.txt与一些任意内容。

我错过了什么吗?或者Global Shared Library没有在通常的Jenkins场所中显示文档:enter image description here

+2

显然它工作得很好,但它在第一次构建完成后再次出现。 – luka5z

+0

我的自定义步骤的文档被附加到刚刚成功使用它的项目的'pipeline-syntax/globals'部分的列表中。但是,HTML标签以文本形式出现,并且文档没有说明预计哪种降价格式? –

回答

1

请注意,PipelineSyntax/Global变量参考页面仅在管道运行成功时更新。因此只适用于此管道(而不是其他任何)。

Here's a link