jenkins/sap-jenkins-library
1
0
Fork 0
mirror of https://github.com/SAP/jenkins-library.git synced 2026-06-19 22:58:55 +02:00
Code Issues Releases Activity

Separate step rendering from step evaluation

Browse Source 
... in preparation of additional tags making use of interdependencies between steps,
e.g. something like a '@see' tag for re-using descriptions from other steps.
This commit is contained in:
Marcus Holl
2018-10-29 14:02:16 +01:00
parent 67bc3f633d
commit f09cd638bb
1 changed files with 31 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files
createDocu.groovy
+31 -9
View File
@@ -318,14 +318,20 @@ def prepareDefaultValuesStep = Helper.getPrepareDefaultValuesStep(gse)
boolean exceptionCaught = false
def stepDescriptors = [:]
for (step in steps) {
try {
handleStep(step, prepareDefaultValuesStep, gse)
stepDescriptors."${step}" = handleStep(step, prepareDefaultValuesStep, gse)
} catch(Exception e) {
exceptionCaught = true
System.err << "${e.getClass().getName()} caught while handling step '${step}': ${e.getMessage()}.\n"
}
}
for(step in stepDescriptors) {
renderStep(step.key, step.value)
}
if(exceptionCaught) {
System.err << "[ERROR] Exception caught during generating documentation. Check earlier log for details.\n"
System.exit(1)
@@ -333,8 +339,8 @@ if(exceptionCaught) {
System.err << "[INFO] done.\n"
void handleStep(stepName, prepareDefaultValuesStep, gse) {
File theStep = new File(stepsDir, "${stepName}.groovy")
void renderStep(stepName, stepProperties) {
File theStepDocuInput = new File(stepsDocuDir, "${stepName}.md")
File theGeneratedStepDocu = new File(outDir, "${stepName}.md")
@@ -343,6 +349,27 @@ void handleStep(stepName, prepareDefaultValuesStep, gse) {
return
}
def text = theStepDocuInput.text
if(stepProperties.description) {
text = text.replace('__STEP_DESCRIPTION__', stepProperties.description)
}
if(stepProperties.parameters) {
text = text.replace('__PARAMETER_TABLE__', TemplateHelper.createParametersTable(stepProperties.parameters))
text = text.replace('__PARAMETER_DESCRIPTION__', TemplateHelper.createParameterDescriptionSection(stepProperties.parameters))
}
theGeneratedStepDocu.withWriter { w -> w.write text }
}
def handleStep(stepName, prepareDefaultValuesStep, gse) {
File theStep = new File(stepsDir, "${stepName}.groovy")
File theStepDocuInput = new File(stepsDocuDir, "${stepName}.md")
if(!theStepDocuInput.exists()) {
System.err << "[WARNING] step docu input file for step '${stepName}' is missing.\n"
return
}
System.err << "[INFO] Handling step '${stepName}'.\n"
def defaultConfig = Helper.getConfigHelper(getClass().getClassLoader(), roots).loadStepDefaults(Helper.getDummyScript(prepareDefaultValuesStep, stepName)).use()
@@ -404,10 +431,5 @@ void handleStep(stepName, prepareDefaultValuesStep, gse) {
Helper.scanDocu(theStep, step)
def text = theStepDocuInput.text
text = text.replace('__STEP_DESCRIPTION__', step.description)
text = text.replace('__PARAMETER_TABLE__', TemplateHelper.createParametersTable(step.parameters))
text = text.replace('__PARAMETER_DESCRIPTION__', TemplateHelper.createParameterDescriptionSection(step.parameters))
theGeneratedStepDocu.withWriter { w -> w.write text }
step
}