1
0
mirror of https://github.com/SAP/jenkins-library.git synced 2025-06-15 00:05:11 +02:00
Files
sap-jenkins-library/documentation/docs/steps/commonPipelineEnvironment/setMtarFileName.md
2017-11-10 16:30:52 +01:00

32 lines
668 B
Markdown

# setMtarFileName
## Description
Sets the file name of the mtar archive. The mtar archive is created in the [mtaBuild](../../steps/mtaBuild) step.
This does not change the file name of the actual mtar archive file.
## Parameters
| parameter | mandatory | default | possible values |
| ---------------|-----------|---------|-----------------|
| `mtarFileName` | yes | | |
* `mtarFileName` - the String to be set as value for `mtarFileName` in `commonPipelineEnvironment`.
## Return values
none
## Side effects
none
## Exceptions
none
## Example
```groovy
commonPipelineEnvironment.setMtarFileName('my.file.name.mtar')
```