1
0
mirror of https://github.com/SAP/jenkins-library.git synced 2025-06-27 00:41:29 +02:00

Dokumentation: Introduce Jenkins plugin dependencies

This commit is contained in:
Marcus Holl
2019-05-20 09:32:49 +02:00
parent 41ee87d147
commit d21dd9c87b
2 changed files with 10 additions and 1 deletions

View File

@ -13,6 +13,12 @@ import com.sap.piper.MapUtils
// //
class TemplateHelper { class TemplateHelper {
static createDependencyList() {
def t = ''
t += 'The step depends on the following Jenkins plugins'
return t
}
static createParametersTable(Map parameters) { static createParametersTable(Map parameters) {
def t = '' def t = ''
@ -525,7 +531,8 @@ void renderStep(stepName, stepProperties) {
docGenStepName : stepName, docGenStepName : stepName,
docGenDescription : 'Description\n\n' + stepProperties.description, docGenDescription : 'Description\n\n' + stepProperties.description,
docGenParameters : 'Parameters\n\n' + TemplateHelper.createParametersSection(stepProperties.parameters), 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) def template = new StreamingTemplateEngine().createTemplate(theStepDocu.text)
String text = template.make(binding) String text = template.make(binding)

View File

@ -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). * **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} ## ${docGenParameters}
## ${docGenConfiguration} ## ${docGenConfiguration}