mirror of
https://github.com/SAP/jenkins-library.git
synced 2025-05-31 23:09:34 +02:00
f757a0e1d4
* fix Markdown issue 'Headers should be surrounded by blank lines' * fix MD012 * fix MD022 * fix MD026 * fix MD007 * fix MD032 * fix MD038 * fix MD040 * fix MD031 * fix MD034 * fix MD004 * fix new findings * fix MD036 * fix MD038 * fix MD032 * fix MD006
46 lines
1.2 KiB
Markdown
46 lines
1.2 KiB
Markdown
# setupCommonPipelineEnvironment
|
|
|
|
## Description
|
|
|
|
Initializes the [`commonPipelineEnvironment`](commonPipelineEnvironment.md), 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
|
|
|
|
```groovy
|
|
setupCommonPipelineEnvironment script: this
|
|
```
|