From d21dd9c87b51a2d9e801167c04d1c15b09c33a1c Mon Sep 17 00:00:00 2001 From: Marcus Holl Date: Mon, 20 May 2019 09:32:49 +0200 Subject: [PATCH] Dokumentation: Introduce Jenkins plugin dependencies --- documentation/bin/createDocu.groovy | 9 ++++++++- documentation/docs/steps/neoDeploy.md | 2 ++ 2 files changed, 10 insertions(+), 1 deletion(-) diff --git a/documentation/bin/createDocu.groovy b/documentation/bin/createDocu.groovy index 7dfe920aa..c20c9901f 100644 --- a/documentation/bin/createDocu.groovy +++ b/documentation/bin/createDocu.groovy @@ -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) diff --git a/documentation/docs/steps/neoDeploy.md b/documentation/docs/steps/neoDeploy.md index 3fb095615..5b98e0ff8 100644 --- a/documentation/docs/steps/neoDeploy.md +++ b/documentation/docs/steps/neoDeploy.md @@ -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}