mirror of
https://github.com/SAP/jenkins-library.git
synced 2025-03-03 15:02:35 +02:00
transportRequestCreate: generate docu
This commit is contained in:
Alejandra Ferreiro Vidal
parent
ea599d0b83
commit
0565b5e63f
@ -1,53 +1,15 @@
|
||||
# transportRequestCreate
|
||||
# ${docGenStepName}
|
||||
|
||||
## Description
|
||||
|
||||
Creates
|
||||
|
||||
* a Transport Request for a Change Document on the Solution Manager (type `SOLMAN`) or
|
||||
* a Transport Request inside an ABAP system (type`CTS`)
|
||||
|
||||
The id of the transport request is availabe via [commonPipelineEnvironment.getTransportRequestId()](commonPipelineEnvironment.md)
|
||||
## ${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.
|
||||
* Solution Manager version `ST720 SP08` or newer.
|
||||
|
||||
## Parameters
|
||||
## ${docGenParameters}
|
||||
|
||||
| parameter | mandatory | default | possible values |
|
||||
| -----------------|-----------|--------------------------------------------------------|--------------------|
|
||||
| `script` | yes | | |
|
||||
| `changeDocumentId` | for `SOLMAN` | | |
|
||||
| `transportType` | for `CTS` | no | |
|
||||
| `targetSystem` | for `CTS` | no | |
|
||||
| `description` | for `CTS` | no | |
|
||||
| `changeManagement/credentialsId` | yes | | |
|
||||
| `changeManagement/endpoint` | yes | | |
|
||||
| `changeManagement/clientOpts` | no | | |
|
||||
| `changeManagement/git/from` | no | `origin/master` | |
|
||||
| `changeManagement/git/to` | no | `HEAD` | |
|
||||
| `changeManagement/changeDocumentLabel` | no | `ChangeDocument\s?:` | regex pattern |
|
||||
| `changeManagement/git/format` | no | `%b` | see `git log --help` |
|
||||
| `changeManagement/type` | no | `SOLMAN` | `SOLMAN`, `CTS` |
|
||||
| `developmentSystemId` | for `SOLMAN` | | |
|
||||
|
||||
* `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 to that the transport request is bound to. Typically this value is provided via commit message in the commit history.
|
||||
* `changeManagement/type` Where/how the transport request is created (via SAP Solution Manager, ABAP).
|
||||
* `changeManagement/credentialsId` - The credentials to connect to the service endpoint (Solution Manager, ABAP System).
|
||||
* `changeManagement/endpoint` - The service endpoint (Solution Manager, ABAP System).
|
||||
* `changeManagement/clientOpts`- Options forwarded to JVM used by the CM client, like `JAVA_OPTS`
|
||||
* `changeManagement/git/from` - The starting point for retrieving the change document id
|
||||
* `changeManagement/git/to` - The end point for retrieving the change document id
|
||||
* `changeManagement/changeDocumentLabel` - For type `SOLMAN` only. A pattern used for identifying lines holding the change document id.
|
||||
* `changeManagement/git/format` - Specifies what part of the commit is scanned. By default the body of the commit message is scanned.
|
||||
* `description` - for `CTS` only. The description of the transport request.
|
||||
* `targetSystem` - for `CTS` only. The system receiving the transport request.
|
||||
* `transportType` - for type `CTS` only. Typically `W` (workbench) or `C` customizing.
|
||||
* `developmentSystemId`- for `SOLMAN` only. The logical system id for which the transport request is created. The format is `<SID>~<TYPE>(/<CLIENT>)?`. For ABAP Systems the `developmentSystemId` looks like `DEV~ABAP/100`. For non-ABAP systems the `developmentSystemId` looks like e.g. `L21~EXT_SRV` or `J01~JAVA`. In case the system type is not known (in the examples provided here: `EXT_SRV` or `JAVA`) the information can be retrieved from the Solution Manager instance.
|
||||
## Step configuration
|
||||
## ${docGenConfiguration}
|
||||
|
||||
The step is configured using a customer configuration file provided as
|
||||
resource in an custom shared library.
|
||||
|
||||
@ -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,101 @@ import hudson.AbortException
|
||||
|
||||
@Field Set STEP_CONFIG_KEYS = [
|
||||
'changeManagement',
|
||||
'description', // CTS
|
||||
'developmentSystemId', // SOLMAN
|
||||
'targetSystem', // CTS
|
||||
'transportType', // CTS
|
||||
'verbose', // RFC
|
||||
]
|
||||
/**
|
||||
* @see checkChangeInDevelopment
|
||||
* @parentConfigKey changeManagement
|
||||
*/
|
||||
'changeDocumentLabel',
|
||||
/**
|
||||
* Defines where the transport request is created, e.g. SAP Solution Manager, ABAP System.
|
||||
* @parentConfigKey changeManagement
|
||||
* @possibleValues `SOLMAN`, `CTS`, `RFC`
|
||||
*/
|
||||
'type',
|
||||
/**
|
||||
* @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',
|
||||
/**
|
||||
* AS ABAP instance number. Only for `RFC`.
|
||||
* @parentConfigKey changeManagement
|
||||
*/
|
||||
'rfc/developmentInstance',
|
||||
/**
|
||||
* AS ABAP client number. Only for `RFC`.
|
||||
* @parentConfigKey changeManagement
|
||||
*/
|
||||
'rfc/developmentClient',
|
||||
/**
|
||||
* The logical system id for which the transport request is created.
|
||||
* The format is `<SID>~<TYPE>(/<CLIENT>)?`. For ABAP Systems the `developmentSystemId`
|
||||
* looks like `DEV~ABAP/100`. For non-ABAP systems the `developmentSystemId` looks like
|
||||
* e.g. `L21~EXT_SRV` or `J01~JAVA`. In case the system type is not known (in the examples
|
||||
* provided here: `EXT_SRV` or `JAVA`) the information can be retrieved from the Solution Manager instance.
|
||||
* Only for `SOLMAN`.
|
||||
*/
|
||||
'developmentSystemId',
|
||||
/**
|
||||
* The description of the transport request. Only for `CTS`.
|
||||
*/
|
||||
'description',
|
||||
/**
|
||||
* The system receiving the transport request. Only for `CTS`.
|
||||
*/
|
||||
'targetSystem',
|
||||
/**
|
||||
* Typically `W` (workbench) or `C` customizing. Only for `CTS`.
|
||||
*/
|
||||
'transportType',
|
||||
/**
|
||||
* Provides additional details. Only for `RFC`.
|
||||
*/
|
||||
'verbose'
|
||||
]
|
||||
|
||||
@Field Set PARAMETER_KEYS = STEP_CONFIG_KEYS.plus(['changeDocumentId'])
|
||||
@Field Set PARAMETER_KEYS = STEP_CONFIG_KEYS.plus([
|
||||
/** The id of the change document to that the transport request is bound to.
|
||||
* Typically this value is provided via commit message in the commit history.
|
||||
* Only for `SOLMAN`.
|
||||
*/
|
||||
'changeDocumentId'
|
||||
])
|
||||
|
||||
/**
|
||||
* Creates
|
||||
*
|
||||
* * a Transport Request for a Change Document on the Solution Manager (type `SOLMAN`) or
|
||||
* * a Transport Request inside an ABAP system (type`CTS`)
|
||||
*
|
||||
* The id of the transport request is availabe via [commonPipelineEnvironment.getTransportRequestId()](commonPipelineEnvironment.md)
|
||||
*/
|
||||
@GenerateDocumentation
|
||||
void call(parameters = [:]) {
|
||||
|
||||
def transportRequestId
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user