mirror of
https://github.com/SAP/jenkins-library.git
synced 2025-04-25 12:24:42 +02:00
Dokumentation: Introduce Jenkins plugin dependencies
This commit is contained in:
parent
41ee87d147
commit
d21dd9c87b
@ -13,6 +13,12 @@ import com.sap.piper.MapUtils
|
||||
//
|
||||
class TemplateHelper {
|
||||
|
||||
static createDependencyList() {
|
||||
def t = ''
|
||||
t += 'The step depends on the following Jenkins plugins'
|
||||
return t
|
||||
}
|
||||
|
||||
static createParametersTable(Map parameters) {
|
||||
|
||||
def t = ''
|
||||
@ -525,7 +531,8 @@ void renderStep(stepName, stepProperties) {
|
||||
docGenStepName : stepName,
|
||||
docGenDescription : 'Description\n\n' + stepProperties.description,
|
||||
docGenParameters : 'Parameters\n\n' + TemplateHelper.createParametersSection(stepProperties.parameters),
|
||||
docGenConfiguration : 'Step configuration\n\n' + TemplateHelper.createStepConfigurationSection(stepProperties.parameters)
|
||||
docGenConfiguration : 'Step configuration\n\n' + TemplateHelper.createStepConfigurationSection(stepProperties.parameters),
|
||||
docDependencies : 'Dependencies\n\n' + TemplateHelper.createDependencyList()
|
||||
]
|
||||
def template = new StreamingTemplateEngine().createTemplate(theStepDocu.text)
|
||||
String text = template.make(binding)
|
||||
|
@ -14,6 +14,8 @@
|
||||
|
||||
* **Java 8 or compatible version** - needed by the *Neo-Java-Web-SDK*. Java environment needs to be properly configured (JAVA_HOME, java exectutable contained in path).
|
||||
|
||||
## ${docDependencies}
|
||||
|
||||
## ${docGenParameters}
|
||||
|
||||
## ${docGenConfiguration}
|
||||
|
Loading…
x
Reference in New Issue
Block a user