jenkins/sap-jenkins-library
1
0
Fork 0
mirror of https://github.com/SAP/jenkins-library.git synced 2024-12-14 11:03:09 +02:00
Code Issues Releases Activity
48990bac47
sap-jenkins-library/documentation/docs/steps/setupCommonPipelineEnvironment.md
Alejandra Ferreiro Vidal fe6cc8867a add new configuration documentation
2018-03-09 10:27:28 +01:00

1.2 KiB
Raw Blame History

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). Normally this needs to be provided.
  • configFile - Property file defining project specific settings.

Step configuration

none

Return value

none

Side effects

none

Exceptions

none

Example

setupCommonPipelineEnvironment script: this