2019-03-28 11:05:54 +02:00
# ${docGenStepName}
2018-06-20 11:36:41 +02:00
2019-03-28 11:05:54 +02:00
## ${docGenDescription}
2018-11-08 17:05:35 +02:00
2018-06-20 11:36:41 +02:00
## Prerequisites
2018-11-06 14:50:09 +02:00
2019-09-30 12:54:16 +02:00
* **[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. **Note:** This is only required if you don't use a Docker-based environment.
2019-03-26 15:35:52 +02:00
* Solution Manager version `ST720 SP08` or newer.
2018-06-20 11:36:41 +02:00
2019-03-28 11:05:54 +02:00
## ${docGenParameters}
2018-06-20 11:36:41 +02:00
2019-03-28 11:05:54 +02:00
## ${docGenConfiguration}
2018-11-06 14:50:09 +02:00
2019-05-24 15:44:31 +02:00
## ${docJenkinsPluginDependencies}
2019-05-24 15:41:49 +02:00
2018-07-17 09:21:56 +02:00
The step is configured using a customer configuration file provided as
resource in an custom shared library.
2018-06-20 11:36:41 +02:00
2018-11-06 14:50:09 +02:00
```groovy
2018-12-05 14:37:15 +02:00
@Library ('piper-lib-os@master') _
2018-07-17 09:21:56 +02:00
// the shared lib containing the additional configuration
// needs to be configured in Jenkins
2018-11-06 14:50:09 +02:00
@Library ('foo@master') __
2018-07-17 09:21:56 +02:00
// inside the shared lib denoted by 'foo' the additional configuration file
// needs to be located under 'resources' ('resoures/myConfig.yml')
2019-05-17 13:20:13 +02:00
prepareDefaultValues script: this, customDefaults: 'myConfig.yml'
2018-07-17 09:21:56 +02:00
```
2018-11-06 14:50:09 +02:00
Example content of `'resources/myConfig.yml'` in branch `'master'` of the repository denoted by
`'foo'` :
2018-07-17 09:21:56 +02:00
2018-11-06 14:50:09 +02:00
```yaml
2018-07-17 09:21:56 +02:00
general:
changeManagement:
changeDocumentLabel: 'ChangeDocument\s?:'
cmClientOpts: '-Djavax.net.ssl.trustStore=< path to truststore > '
credentialsId: 'CM'
2018-09-28 10:00:59 +02:00
type: 'SOLMAN'
2018-07-17 09:21:56 +02:00
endpoint: 'https://example.org/cm'
git:
from: 'HEAD~1'
to: 'HEAD'
format: '%b'
```
The properties configured in section `'general/changeManagement'` are shared between
2020-09-24 07:41:06 +02:00
all change management related steps.
2018-07-17 09:21:56 +02:00
The properties can also be configured on a per-step basis:
2018-11-06 14:50:09 +02:00
```yaml
2018-07-17 09:21:56 +02:00
[...]
steps:
transportRequestCreate:
changeManagement:
2018-09-28 10:00:59 +02:00
type: 'SOLMAN'
2018-07-17 09:21:56 +02:00
endpoint: 'https://example.org/cm'
[...]
```
The parameters can also be provided when the step is invoked. For examples see below.
2018-06-20 11:36:41 +02:00
## Return value
2018-11-06 14:50:09 +02:00
2018-11-08 17:05:35 +02:00
none
2018-06-20 11:36:41 +02:00
## Exceptions
2018-11-06 14:50:09 +02:00
2018-06-20 11:36:41 +02:00
* `AbortException` :
2018-11-06 14:50:09 +02:00
* If the creation of the transport request fails.
2018-07-17 09:21:56 +02:00
* `IllegalStateException` :
2018-11-06 14:50:09 +02:00
* If the change id is not provided.
2018-06-20 11:36:41 +02:00
## Example
2018-11-06 14:50:09 +02:00
2018-06-20 11:36:41 +02:00
```groovy
2018-09-28 10:00:59 +02:00
// SOLMAN
2018-07-17 09:21:56 +02:00
def transportRequestId = transportRequestCreate script:this,
changeDocumentId: '001,'
changeManagement: [
2018-09-28 10:00:59 +02:00
type: 'SOLMAN'
endpoint: 'https://example.org/cm'
]
// CTS
def transportRequestId = transportRequestCreate script:this,
transportType: 'W',
targetSystem: 'XYZ',
description: 'the description',
changeManagement: [
type: 'CTS'
2018-07-17 09:21:56 +02:00
endpoint: 'https://example.org/cm'
]
2018-06-20 11:36:41 +02:00
```