You've already forked sap-jenkins-library
mirror of
https://github.com/SAP/jenkins-library.git
synced 2025-12-03 23:10:20 +02:00
8e70c72ea9
Slight improvements on various md files. Deletion of method-based commonPipelineEnvironment documentation as it is not used.
1.2 KiB
1.2 KiB
setupCommonPipelineEnvironment
Description
Initializes the commonPipelineEnvironment, which is used throughout the complete pipeline.
!!! tip
This step needs to run at the beginning of a pipeline right after the SCM checkout.
Then subsequent pipeline steps consume the information from commonPipelineEnvironment; it does not need to be passed to pipeline steps explicitly.
Prerequisites
- A configuration file with properties (default location:
.pipeline/config.properties). The property values are used as default values in many pipeline steps.
Parameters
| parameter | mandatory | default | possible values |
|---|---|---|---|
script |
yes | - | |
configFile |
no | .pipeline/config.properties |
script- The reference to the pipeline script (Jenkinsfile). Normallythisneeds to be provided.configFile- Property file defining project specific settings.
Return value
none
Side effects
none
Exceptions
none
Example
setupCommonPipelineEnvironment script: this