github.com/ouraigua/jenkins-library@v0.0.0-20231028010029-fbeaf2f3aa9b/documentation/docs/steps/transportRequestRelease.md (about)

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