jenkins/sap-jenkins-library
1
0
Fork 0
mirror of https://github.com/SAP/jenkins-library.git synced 2025-03-03 15:02:35 +02:00
Code Issues Releases Activity

prepareDefaultValues: generate docu (#634)

Browse Source
This commit is contained in:
Alejandra Ferreiro Vidal 2019-04-09 09:52:45 +02:00 committed by Oliver Nocon
parent 998dd99cf5
commit fa05b0bcb6
2 changed files with 10 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
documentation/docs/steps/prepareDefaultValues.md
View File

@ -1,17 +1,10 @@
# prepareDefaultValues
# ${docGenStepName}
## Description
## ${docGenDescription}
Loads the pipeline library default values from the file `resources/default_pipeline_environment.yml`.
Afterwards the values can be loaded by the method: `ConfigurationLoader.defaultStepConfiguration`
## ${docGenParameters}
## Parameters
None
## Step configuration
None
## ${docGenConfiguration}
## Exceptions

6
vars/prepareDefaultValues.groovy
View File

@ -1,3 +1,4 @@
import com.sap.piper.GenerateDocumentation
import com.sap.piper.DefaultValueCache
import com.sap.piper.MapUtils
@ -5,6 +6,11 @@ import groovy.transform.Field
@Field STEP_NAME = getClass().getName()
/**
* Loads the pipeline library default values from the file `resources/default_pipeline_environment.yml`.
* Afterwards the values can be loaded by the method: `ConfigurationLoader.defaultStepConfiguration`
*/
@GenerateDocumentation
void call(Map parameters = [:]) {
if(!DefaultValueCache.getInstance() || parameters.customDefaults) {
def defaultValues = [:]