github.com/xgoffin/jenkins-library@v1.154.0/documentation/docs/steps/transportRequestRelease.md (about)

     1  # ${docGenStepName}
     2  
     3  ## ${docGenDescription}
     4  
     5  ## Prerequisites
     6  
     7  * No prerequisites
     8  
     9  ## ${docGenParameters}
    10  
    11  ## ${docGenConfiguration}
    12  
    13  ## ${docJenkinsPluginDependencies}
    14  
    15  The step is configured using a customer configuration file provided as
    16  resource in an custom shared library.
    17  
    18  ```groovy
    19  @Library('piper-lib-os@master') _
    20  
    21  // the shared lib containing the additional configuration
    22  // needs to be configured in Jenkins
    23  @Library('foo@master') __
    24  
    25  // inside the shared lib denoted by 'foo' the additional configuration file
    26  // needs to be located under 'resources' ('resoures/myConfig.yml')
    27  prepareDefaultValues script: this,
    28                               customDefaults: 'myConfig.yml'
    29  ```
    30  
    31  Example content of `'resources/myConfig.yml'` in branch `'master'` of the repository denoted by
    32  `'foo'`:
    33  
    34  ```yaml
    35  general:
    36    changeManagement:
    37      changeDocumentLabel: 'ChangeDocument\s?:'
    38      cmClientOpts: '-Djavax.net.ssl.trustStore=<path to truststore>'
    39      credentialsId: 'CM'
    40      type: 'SOLMAN'
    41      endpoint: 'https://example.org/cm'
    42      git:
    43        from: 'HEAD~1'
    44        to: 'HEAD'
    45        format: '%b'
    46  ```
    47  
    48  The properties configured in section `'general/changeManagement'` are shared between all change management related steps.
    49  
    50  The properties can also be configured on a per-step basis:
    51  
    52  ```yaml
    53    [...]
    54    steps:
    55      transportRequestRelease:
    56        changeManagement:
    57          type: 'SOLMAN'
    58          endpoint: 'https://example.org/cm'
    59          [...]
    60  ```
    61  
    62  The parameters can also be provided when the step is invoked. For examples see below.
    63  
    64  ## Exceptions
    65  
    66  * `IllegalArgumentException`:
    67    * If the change id is not provided (`SOLMAN` only)
    68    * If the transport request id is not provided.
    69  * `AbortException`:
    70    * If the release of the transport request fails.
    71  
    72  ## Example
    73  
    74  ```groovy
    75  // SOLMAN
    76  transportRequestRelease script:this,
    77                          changeDocumentId: '001',
    78                          transportRequestId: '001',
    79                          changeManagement: [
    80                            type: 'SOLMAN'
    81                            endpoint: 'https://example.org/cm'
    82                          ]
    83  // CTS
    84  transportRequestRelease script:this,
    85                          transportRequestId: '001',
    86                          changeManagement: [
    87                            type: 'CTS'
    88                            endpoint: 'https://example.org/cm'
    89                          ]
    90  ```