1
0
mirror of https://github.com/SAP/jenkins-library.git synced 2025-10-30 23:57:50 +02:00

Remove prerequisites from docu inside step

--> will be contained in the md file instead.
This commit is contained in:
Marcus Holl
2018-11-02 13:30:32 +01:00
parent 84476322ff
commit d410ddea59
2 changed files with 28 additions and 6 deletions

View File

@@ -128,6 +128,29 @@ class Helper {
}
}
static trim(List lines) {
removeLeadingEmptyLines(
removeLeadingEmptyLines(lines.reverse())
.reverse())
}
private static removeLeadingEmptyLines(lines) {
def _lines = new ArrayList(lines), trimmed = []
boolean empty = true
_lines.each() {
if(empty && ! it.trim()) return
empty = false
trimmed << it
}
trimmed
}
private static normalize(Set p) {
def normalized = [] as Set
@@ -185,6 +208,7 @@ class Helper {
if(isHeader(line)) {
def _docu = []
docuLines.each { _docu << it }
_docu = Helper.trim(_docu)
step.description = _docu*.trim().join('\n')
} else {
@@ -384,13 +408,13 @@ void renderStep(stepName, stepProperties) {
def text = theStepDocu.text
if(stepProperties.description) {
text = TemplateHelper.replaceParagraph(text, 2, 'Description', stepProperties.description)
text = TemplateHelper.replaceParagraph(text, 2, 'Description', '\n' + stepProperties.description)
}
if(stepProperties.parameters) {
text = TemplateHelper.replaceParagraph(text, 2, 'Parameters',
TemplateHelper.createParametersTable(stepProperties.parameters) + '\n\n' +
TemplateHelper.createParameterDescriptionSection(stepProperties.parameters) + '\n\n' +
text = TemplateHelper.replaceParagraph(text, 2, 'Parameters', '\n' +
TemplateHelper.createParametersTable(stepProperties.parameters) + '\n' +
TemplateHelper.createParameterDescriptionSection(stepProperties.parameters) + '\n' +
TemplateHelper.createStepConfigurationSection(stepProperties.parameters))
}
theStepDocu.withWriter { w -> w.write text }

View File

@@ -30,8 +30,6 @@ import com.sap.piper.cm.ChangeManagementException
* By default the git commit messages between `origin/master` and `HEAD` are scanned for a line like `ChangeDocument : <changeDocumentId>`. The commit
* range and the pattern can be configured. For details see 'parameters' table.
*
* ## Prerequisites
* * **[Change Management Client 2.0.0 or compatible version](http://central.maven.org/maven2/com/sap/devops/cmclient/dist.cli/)** - available for download on Maven Central.
*/
def call(parameters = [:]) {