jenkins/sap-jenkins-library
1
0
Fork 0
mirror of https://github.com/SAP/jenkins-library.git synced 2024-12-12 10:55:20 +02:00
Code Issues Releases Activity

doc: fix rendering of stage overview (#3371)

Browse Source
This commit is contained in:
Oliver Nocon 2021-12-17 08:45:21 +01:00 committed by GitHub
parent 9180f54f86
commit bad3331597
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
pkg/documentation/generator/main.go
View File

@ -279,10 +279,10 @@ func createPipelineOverviewDocumentation(stageRunConfig *config.RunConfigV1, sta
overviewFileName := "overview.md"
overviewDoc := fmt.Sprintf("# %v\n\n", stageRunConfig.PipelineConfig.Metadata.DisplayName)
overviewDoc += fmt.Sprintf("%v\n\n", stageRunConfig.PipelineConfig.Metadata.Description)
overviewDoc += fmt.Sprintf("The %v comprises following stages\n\n", stageRunConfig.PipelineConfig.Metadata.Description)
overviewDoc += fmt.Sprintf("The %v comprises following stages\n\n", stageRunConfig.PipelineConfig.Metadata.DisplayName)
for _, stage := range stageRunConfig.PipelineConfig.Spec.Stages {
stageFilePath := filepath.Join(stageTargetPath, fmt.Sprintf("%v.md", stage.Name))
overviewDoc += fmt.Sprintf("* [%v Stage](%v)", stage.DisplayName, stageFilePath)
overviewDoc += fmt.Sprintf("* [%v Stage](%v)\n", stage.DisplayName, stageFilePath)
}
overviewFilePath := filepath.Join(stageTargetPath, overviewFileName)
fmt.Println("writing file", overviewFilePath)
@ -292,8 +292,8 @@ func createPipelineOverviewDocumentation(stageRunConfig *config.RunConfigV1, sta
const stepConditionDetails = `!!! note "Step condition details"
There are currently several conditions which can be checked.<br />**Important: It will be sufficient that any one condition per step is met.**
* ` + "`" + `config` + "`" + `: Checks if a defined configuration parameter is set.
* ` + "`" + `config value` + "`" + `: Checks if a configuration parameter has a defined value.
* ` + "`" + `config` + "`" + `: Checks if a configuration parameter has a defined value.
* ` + "`" + `config key` + "`" + `: Checks if a defined configuration parameter is set.
* ` + "`" + `file pattern` + "`" + `: Checks if files according a defined pattern exist in the project.
* ` + "`" + `file pattern from config` + "`" + `: Checks if files according a pattern defined in the custom configuration exist in the project.
* ` + "`" + `npm script` + "`" + `: Checks if a npm script exists in one of the package.json files in the repositories.