mirror of
https://github.com/SAP/jenkins-library.git
synced 2024-12-14 11:03:09 +02:00
88 lines
3.5 KiB
Markdown
88 lines
3.5 KiB
Markdown
|
# Develop Hybrid Applications with Jenkins and SAP Solution Manager
|
||
|
|
|
||
|
|
Set up an agile development process with Jenkins CI, which automatically feeds changes into SAP Solution Manager.
|
||
|
|
|
||
|
|
## Prerequisites
|
||
|
|
|
||
|
|
* You have installed the Java Runtime Environment 8.
|
||
|
|
* You have installed Jenkins 2.60.3 or higher.
|
||
|
|
* You have set up Project “Piper”. See [README](https://github.com/SAP/jenkins-library/blob/master/README.md).
|
||
|
|
* You have installed SAP Solution Manager 7.2 SP6. See [README](https://github.com/SAP/devops-cm-client/blob/master/README.md).
|
||
|
|
* You have installed the Multi-Target Application (MTA) Archive Builder 1.0.6 or newer. See [SAP Development Tools](https://tools.hana.ondemand.com/#cloud).
|
||
|
|
* You have installed Node.js including node and npm. See https://nodejs.org/en/download/.
|
||
|
|
|
||
|
|
## Context
|
||
|
|
|
||
|
|
In many SAP development scenarios, it is vital to synchronize both backend and frontend deliveries. These deliveries are typically an SAP UI5 application and an ABAP backend from which it is served. The SAP UI5 parts are often developed using agile practices and use Continuous Integration pipelines that automatically build, test, and deploy the application.
|
||
|
|
|
||
|
|
In this scenario, we want to show how an agile development process with Jenkins CI can automatically feed changes into SAP Solution Manager. In SAP Solution Manager, all parts of the application stack come together and can be subject to classic change and transport management.
|
||
|
|
|
||
|
|
The basic workflow is as follows:
|
||
|
|
|
||
|
|
1. The pipeline scans the Git commit messages between `origin/master` and `HEAD` for a line like `ChangeDocument : <changeDocumentId>`, and validates that the change is in the correct status `in development`.The template for the commit message looks as follows:
|
||
|
|
|
||
|
|
```
|
||
|
|
<Commit Message Header>
|
||
|
|
|
||
|
|
<Commit Message Description>
|
||
|
|
|
||
|
|
ChangeDocument: <Your Change Document ID>
|
||
|
|
```
|
||
|
|
|
||
|
|
2. To communicate with SAP Solution Manager, the pipeline uses credentials that must be stored on Jenkins under the label `CM`.
|
||
|
|
3. The required transport request is created on the fly. However, the change document can contain more components (for example, UI and backend components).
|
||
|
|
4. The changes of your development team trigger the Jenkins pipeline. It builds and validates the changes and attaches them to the respective transport request.
|
||
|
|
5. As soon as the development process is completed, the change document in SAP Solution Manager can be set to status `to be tested` and all components can be transported to the test system.
|
||
|
|
|
||
|
|
## Example
|
||
|
|
|
||
|
|
### Jenkinsfile
|
||
|
|
|
||
|
|
```groovy
|
||
|
|
@Library('piper-library-os') _
|
||
|
|
|
||
|
|
node() {
|
||
|
|
|
||
|
|
stage('prepare') {
|
||
|
|
checkout scm
|
||
|
|
setupCommonPipelineEnvironment script:this
|
||
|
|
checkChangeInDevelopment script: this
|
||
|
|
}
|
||
|
|
|
||
|
|
stage('buildMta') {
|
||
|
|
mtaBuild script: this
|
||
|
|
}
|
||
|
|
|
||
|
|
stage('uploadToTransportRequest') {
|
||
|
|
transportRequestCreate script: this
|
||
|
|
transportRequestUploadFile script:this
|
||
|
|
transportRequestRelease script: this
|
||
|
|
}
|
||
|
|
|
||
|
|
}
|
||
|
|
```
|
||
|
|
|
||
|
|
### Configuration (`.pipeline/config.yml`)
|
||
|
|
|
||
|
|
```yaml
|
||
|
|
#Steps Specific Configuration
|
||
|
|
general:
|
||
|
|
changeManagement:
|
||
|
|
endpoint: 'https://<backend-system>/sap/opu/odata/sap/AI_CRM_GW_CM_CI_SRV'
|
||
|
|
credentialsId: 'CM'
|
||
|
|
type: 'SOLMAN'
|
||
|
|
steps:
|
||
|
|
mtaBuild:
|
||
|
|
buildTarget: 'NEO'
|
||
|
|
transportRequestUploadFile:
|
||
|
|
applicationId: 'HCP'
|
||
|
|
```
|
||
|
|
|
||
|
|
### Parameters
|
||
|
|
|
||
|
|
For the detailed description of the relevant parameters, see:
|
||
|
|
|
||
|
|
* [checkChangeInDevelopment](https://sap.github.io/jenkins-library/steps/checkChangeInDevelopment/)
|
||
|
|
* [mtaBuild](https://sap.github.io/jenkins-library/steps/mtaBuild/)
|
||
|
|
* [transportRequestUploadFile](https://sap.github.io/jenkins-library/steps/transportRequestUploadFile/)
|