jenkins/sap-jenkins-library
1
0
Fork 0
mirror of https://github.com/SAP/jenkins-library.git synced 2025-01-20 05:19:40 +02:00
Code Issues Releases Activity

transportRequestRelease: generate docu

Browse Source
This commit is contained in:
Alejandra Ferreiro Vidal 2019-03-28 10:06:40 +01:00
parent 4157963ef6
commit 19f9005dc5
2 changed files with 52 additions and 30 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
documentation/docs/steps/transportRequestRelease.md
View File

@ -1,41 +1,17 @@
# transportRequestRelease
# ${docGenStepName}
## Description
Releases a Transport Request.
## ${docGenDescription}
## Prerequisites
* **[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.
## Parameters
## ${docGenParameters}
| parameter | mandatory | default | possible values |
| -----------------|-----------|--------------------------------------------------------|--------------------|
| `script` | yes | | |
| `changeDocumentId` | `SOLMAN` only | | |
| `transportRequestId`| yes | | |
| `changeManagement/changeDocumentLabel` | no | `ChangeDocument\s?:` | regex pattern |
| `changeManagment/transportRequestLabel` | no | `TransportRequest\s?:` | regex pattern |
| `changeManagement/credentialsId` | yes | | |
| `changeManagement/endpoint` | yes | | |
| `changeManagement/git/from` | no | `origin/master` | |
| `changeManagement/git/to` | no | `HEAD` | |
| `changeManagement/git/format` | no | `%b` | see `git log --help` |
| `changeManagement/type` | no | `SOLMAN` | `SOLMAN`, `CTS` |
* `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`](commonPipelineEnvironment.md) for retrieving, for example, configuration parameters.
* `changeDocumentId` - for `SOLMAN` only. The id of the change document related to the transport request to release.
* `transportRequestId` - The id of the transport request to release.
* `changeManagement/changeDocumentLabel` - for `SOLMAN` only. A pattern used for identifying lines holding the change document id.
* `changeManagment/transportRequestLabel` - A pattern used for identifying lines holding the transport request id.
* `changeManagement/credentialsId` - The credentials to connect to the service endpoint (Solution Manager, ABAP System).
* `changeManagement/endpoint` - The service endpoint (Solution Manager, ABAP System).
* `changeManagement/git/from` - The starting point for retrieving the change document id and/or transport request id
* `changeManagement/git/to` - The end point for retrieving the change document id and/or transport request id
* `changeManagement/git/format` - Specifies what part of the commit is scanned. By default the body of the commit message is scanned.
## ${docGenConfiguration}
## Step configuration
The step is configured using a customer configuration file provided as
resource in an custom shared library.

48
vars/transportRequestRelease.groovy
View File

@ -3,6 +3,7 @@ import static com.sap.piper.Prerequisites.checkScript
import com.sap.piper.Utils
import groovy.transform.Field
import com.sap.piper.GenerateDocumentation
import com.sap.piper.ConfigurationHelper
import com.sap.piper.cm.BackendType
import com.sap.piper.cm.ChangeManagement
@ -19,15 +20,60 @@ import static com.sap.piper.cm.StepHelpers.getBackendTypeAndLogInfoIfCMIntegrati
@Field Set GENERAL_CONFIG_KEYS = STEP_CONFIG_KEYS
@Field Set STEP_CONFIG_KEYS = [
'changeManagement'
'changeManagement',
/**
* @see checkChangeInDevelopment
* @parentConfigKey changeManagement
*/
'clientOpts',
/**
* @see checkChangeInDevelopment
* @parentConfigKey changeManagement
*/
'credentialsId',
/**
* @see checkChangeInDevelopment
* @parentConfigKey changeManagement
*/
'endpoint',
/**
* @see checkChangeInDevelopment
* @parentConfigKey changeManagement
*/
'git/from',
/**
* @see checkChangeInDevelopment
* @parentConfigKey changeManagement
*/
'git/to',
/**
* @see checkChangeInDevelopment
* @parentConfigKey changeManagement
*/
'git/format',
/**
* @see transportRequestCreate
* @parentConfigKey changeManagement
*/
'rfc/developmentInstance',
/**
* @see transportRequestCreate
* @parentConfigKey changeManagement
*/
'rfc/developmentClient',
]
@Field Set PARAMETER_KEYS = STEP_CONFIG_KEYS.plus([
/** @see transportRequestCreate */
'changeDocumentId',
/** The id of the transport request to release. */
'transportRequestId',
/** @see transportRequestCreate */
'verbose',
])
/** Releases a Transport Request. */
@GenerateDocumentation
void call(parameters = [:]) {
handlePipelineStepErrors (stepName: STEP_NAME, stepParameters: parameters) {