1
0
mirror of https://github.com/SAP/jenkins-library.git synced 2024-12-16 11:09:33 +02:00
sap-jenkins-library/documentation/docs/steps/transportRequestRelease.md

3.2 KiB

transportRequestRelease

Description

Releases a Transport Request for a Change Document on the Solution Manager.

Prerequisites

Parameters

parameter mandatory default possible values
script yes
changeDocumentId yes
transportRequestId yes
credentialsId yes
endpoint yes
gitTransportRequestLabel no TransportRequest\s?: regex pattern
gitFrom no origin/master
gitTo no HEAD
gitChangeDocumentLabel no ChangeDocument\s?: regex pattern
gitFormat no %b see git log --help
  • 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 for retrieving, for example, configuration parameters.
  • changeDocumentId - The id of the change document related to the transport request to release.
  • transportRequestId - The id of the transport request to release.
  • credentialsId - The credentials to connect to the Solution Manager.
  • endpoint - The address of the Solution Manager.
  • gitFrom - The starting point for retrieving the change document id
  • gitTo - The end point for retrieving the change document id
  • gitChangeDocumentLabel - A pattern used for identifying lines holding the change document id.
  • gitTransportReqeustLabel - A pattern used for identifying lines holding the transport request id.
  • gitFormat - Specifies what part of the commit is scanned. By default the body of the commit message is scanned.

Step configuration

The following parameters can also be specified as step parameters using the global configuration file:

  • credentialsId
  • endpoint

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

transportRequestRelease script:this, changeDocumentId: '001', transportRequestId: '001'