jenkins/sap-jenkins-library
1
0
Fork 0
mirror of https://github.com/SAP/jenkins-library.git synced 2025-01-30 05:59:39 +02:00
Code Issues Releases Activity

remove outdated docu

Browse Source
This commit is contained in:
Alejandra Ferreiro Vidal 2019-04-05 14:50:44 +02:00
parent b962c0d9d3
commit 97ec7d78de
1 changed files with 0 additions and 222 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

222
documentation/docs/steps/commonPipelineEnvironment.md
View File

@ -10,176 +10,6 @@ none
## Method details ## Method details
### getArtifactVersion()
#### Description
Returns the version of the artifact which is build in the pipeline.
#### Parameters
none
#### Return value
A `String` containing the version.
#### Side effects
none
#### Exceptions
none
#### Example
```groovy
def myVersion = commonPipelineEnvironment.getArtifactVersion()
```
### setArtifactVersion(version)
#### Description
Sets the version of the artifact which is build in the pipeline.
#### Parameters
none
#### Return value
none
#### Side effects
none
#### Exceptions
none
#### Example
```groovy
commonPipelineEnvironment.setArtifactVersion('1.2.3')
```
### getConfigProperties()
#### Description
Returns the map of project specific configuration properties. No defensive copy is created.
Write operations to the map are visible further down in the pipeline.
#### Parameters
none
#### Return value
A map containing project specific configuration properties.
#### Side effects
none
#### Exceptions
none
#### Example
```groovy
commonPipelineEnvironment.getConfigProperties()
```
### setConfigProperties(configuration)
#### Description
Sets the map of configuration properties. Any existing map is overwritten.
#### Parameters
* `configuration` - A map containing the new configuration
#### Return value
none
#### Side effects
none
#### Exceptions
none
#### Example
```groovy
commonPipelineEnvironment.setConfigProperties([DEPLOY_HOST: 'deploy-host.com', DEPLOY_ACCOUNT: 'deploy-account'])
```
### getConfigProperty(property)
#### Description
Gets a specific value from the configuration property.
#### Parameters
* `property` - The key of the property.
#### Return value
* The value associated with key `property`. `null` is returned in case the property does not exist.
#### Side effects
none
#### Exceptions
none
#### Example
```groovy
commonPipelineEnvironment.getConfigProperty('DEPLOY_HOST')
```
### setConfigProperty(property, value)
#### Description
Sets property `property` with value `value`. Any existing property with key `property` is overwritten.
#### Parameters
* `property` - The key of the property.
* `value` - The value of the property.
#### Return value
none
#### Side effects
none
#### Exceptions
none
#### Example
```groovy
commonPipelineEnvironment.setConfigProperty('DEPLOY_HOST', 'my-deploy-host.com')
```
### getInfluxCustomData() ### getInfluxCustomData()
#### Description #### Description
@ -239,58 +69,6 @@ none
def myInfluxDataMap = commonPipelineEnvironment.getInfluxCustomDataMap() def myInfluxDataMap = commonPipelineEnvironment.getInfluxCustomDataMap()
``` ```
### getMtarFileName()
#### Description
Returns the path of the mtar archive file.
#### Parameters
none
#### Return value
The path of the mtar archive file.
#### Side effects
none
#### Exceptions
none
#### Example
```groovy
commonPipelineEnvironment.getMtarFileName()
```
### setMtarFileName(name)
#### Description
Sets the path of the mtar archive file. Any old value is discarded.
#### Parameters
* `mtarFilePath` - The path of the mtar archive file name.
#### Side effects
none
#### Exceptions
none
#### Example
```groovy
commonPipelineEnvironment.setMtarFileName('path/to/foo.mtar')
```
### getPipelineMeasurement(measurementName) ### getPipelineMeasurement(measurementName)
#### Description #### Description