Согласно documentation, должно быть возможно включить *.txt
файл с помощью/документацией:Дженкинс Pipeline: Как добавить помощи для глобальной общей библиотеки
(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 хосты сценарии, которые определяют глобальные переменные , доступные из сценариев Pipeline. Базовое имя каждого файла * .groovy должно быть идентификатором Groovy (~ Java), обычно с camelCased. Соответствующий * .txt , если присутствует, может содержать документацию, обработанную через конфигуратор разметки системы, который может быть действительно HTML, Markdown и т. Д., Хотя расширение txt не требуется).
К сожалению, это не сработало для меня, просто создав *.txt
с некоторым произвольным контентом.
Я что-то упустил? Или глобальная общая библиотека не показывает документацию в обычных местах Дженкинса:
Видимо, он работает отлично, но он появился сразу после первой сборки с завершенной библиотекой. – luka5z
Документация моего пользовательского шага добавляется к списку в разделе «конвейер-синтаксис/глобальные переменные» для проекта, который только что успешно использовал его. Однако HTML-теги отображаются как текст, и в документации не указано, какое форматирование уценки ожидается? –