github.com/jaylevin/jenkins-library@v1.230.4/documentation/docs/steps/transportRequestCreate.md (about)

     1  # ${docGenStepName}
     2  
     3  ## ${docGenDescription}
     4  
     5  **Note:** This step is deprecated.
     6  
     7  ## Prerequisites
     8  
     9  * Solution Manager version `ST720 SP08` or newer.
    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, customDefaults: 'myConfig.yml'
    30  ```
    31  
    32  Example content of `'resources/myConfig.yml'` in branch `'master'` of the repository denoted by
    33  `'foo'`:
    34  
    35  ```yaml
    36  general:
    37    changeManagement:
    38      changeDocumentLabel: 'ChangeDocument\s?:'
    39      cmClientOpts: '-Djavax.net.ssl.trustStore=<path to truststore>'
    40      credentialsId: 'CM'
    41      type: 'SOLMAN'
    42      endpoint: 'https://example.org/cm'
    43      git:
    44        from: 'HEAD~1'
    45        to: 'HEAD'
    46        format: '%b'
    47  ```
    48  
    49  The properties configured in section `'general/changeManagement'` are shared between
    50  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      transportRequestCreate:
    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  ## Return value
    67  
    68  none
    69  
    70  ## Exceptions
    71  
    72  * `AbortException`:
    73    * If the creation of the transport request fails.
    74  * `IllegalStateException`:
    75    * If the change id is not provided.
    76  
    77  ## Example
    78  
    79  ```groovy
    80  // SOLMAN
    81  def transportRequestId = transportRequestCreate script:this,
    82                                                  changeDocumentId: '001,'
    83                                                  changeManagement: [
    84                                                    type: 'SOLMAN'
    85                                                    endpoint: 'https://example.org/cm'
    86                                                  ]
    87  // CTS
    88  def transportRequestId = transportRequestCreate script:this,
    89                                                  transportType: 'W',
    90                                                  targetSystem: 'XYZ',
    91                                                  description: 'the description',
    92                                                  changeManagement: [
    93                                                    type: 'CTS'
    94                                                    endpoint: 'https://example.org/cm'
    95                                                  ]
    96  ```