Jenkins Pipeline：如何为全局共享库添加帮助答案

【问题标题】：Jenkins Pipeline: How to add help for Global Shared LibraryJenkins Pipeline：如何为全局共享库添加帮助
【发布时间】：2017-04-30 22:31:51
【问题描述】：

根据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
...

vars 目录包含定义全局变量的脚本可从管道脚本访问。每个 *.groovy 文件的基本名称应该是一个 Groovy (~ Java) 标识符，通常采用驼峰命名法。这匹配的 *.txt，如果存在，可以包含文档，已处理通过系统配置的标记格式化程序（可能真的是 HTML、Markdown 等，但需要 txt 扩展名）。

不幸的是，简单地创建带有一些任意内容的*.txt 对我不起作用。

我错过了什么吗？或者全局共享库是否没有在通常的 Jenkins 位置显示文档：

【问题讨论】：

显然它工作得很好，但它在第一次构建这个库完成后重新出现。
我的自定义步骤的文档被附加到刚刚成功使用它的项目的“管道语法/全局”部分的列表中。但是 HTML 标签显示为文本，并且文档没有说明预期的降价格式？
@simon.watts 您需要在 jenkins 安全配置上启用标记格式化程序，如 here 所述

标签： jenkins jenkins-pipeline

【解决方案1】：

请注意，管道语法/全局变量参考页面仅在管道运行成功时更新。因此仅适用于这条管道（而不是任何其他管道）。

这里是a link！

【讨论】：