jenkins/sap-jenkins-library
1
0
Fork 0
mirror of https://github.com/SAP/jenkins-library.git synced 2025-12-07 23:23:41 +02:00
Code Issues Releases Activity

add step transportRequestUploadFile

Browse Source
This commit is contained in:
Alejandra Ferreiro Vidal
2018-06-20 11:46:28 +02:00
parent e34f99deac
commit 12652be421
4 changed files with 255 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

49
documentation/docs/steps/transportRequestUploadFile.md Normal file
View File

@@ -0,0 +1,49 @@
# transportRequestUploadFile
## Description
Uploads a file to a Transport Request for a Change Document on the Solution Manager.
## Prerequisites
* **[Change Management Client 2.0.0 or compatible version](http://central.maven.org/maven2/com/sap/devops/cmclient/dist.cli/)** - available for download on Maven Central.
## Parameters
| parameter | mandatory | default | possible values |
| -----------------|-----------|--------------------------------------------------------|--------------------|
| `script` | yes | | |
| `changeId` | yes | | |
| `transportRequestId`| yes | | |
| `applicationId` | yes | | |
| `filePath` | yes | | |
| `cmCredentialsId` | yes | | |
| `cmEndpoint` | yes | | |
* `script` - The common script environment of the Jenkinsfile running. Typically the reference to the script calling the pipeline step is provided with the `this` parameter, as in `script: this`. This allows the function to access the [`commonPipelineEnvironment`](commonPipelineEnvironment.md) for retrieving, for example, configuration parameters.
* `changeId` - The id of the change document related to the transport request to release.
* `transportRequestId` - The id of the transport request to release.
* `applicationId` - The id of the application.
* `filePath` - The path of the file to upload.
* `cmCredentialsId` - The credentials to connect to the Solution Manager.
* `cmEndpoint` - The address of the Solution Manager.
## Step configuration
The following parameters can also be specified as step parameters using the global configuration file:
* `cmCredentialsId`
* `cmEndpoint`
## Return value
None.
## Exceptions
* `AbortException`:
* If the change id is not provided.
* If the transport request id is not provided.
* If the application id is not provided.
* If the file path is not provided.
* If the upload fails.
## Example
```groovy
transportRequestUploadFile script:this, changeId: '001', transportRequestId: '001', applicationId: '001', filePath: '/path'
```