jenkins/sap-jenkins-library
1
0 Fork 0
mirror of https://github.com/SAP/jenkins-library.git synced 2026-06-19 22:58:55 +02:00
Code Issues Releases Activity

Merge pull request #162 from alejandraferreirovidal/addCmClient

Browse Source 
Add cm client
This commit is contained in:
Marcus Holl authored and GitHub committed 2018-06-26 14:15:21 +02:00
2 parents 9c5887ebbd 4464c9427b
commit eb5461a8f1
11 files changed
+723
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

documentation/docs/steps/transportRequestCreate.md
+40
View File
@@ -0,0 +1,40 @@
# transportRequestCreate
## Description
Creates 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 | | |
| `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 to transport.
* `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
The id of the Transport Request that has been created.
## Exceptions
* `AbortException`:
* If the change id is not provided.
* If the creation of the transport request fails.
## Example
```groovy
def transportRequestId = transportRequestCreate script:this, changeId: '001'
```
documentation/docs/steps/transportRequestRelease.md
+43
View File
@@ -0,0 +1,43 @@
# transportRequestRelease
## Description
Releases 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 | | |
| `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.
* `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 release of the transport request fails.
## Example
```groovy
transportRequestRelease script:this, changeId: '001', transportRequestId: '001'
```
documentation/docs/steps/transportRequestUploadFile.md
+49
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'
```