Automated CPI Deployments
Last updated
Last updated
Release Pipelines in ReleaseOwl facilitate orchestrated deployments to SAP environments with structured approval workflows. A pipeline can consist of one or more stages, each representing a deployment phase (e.g., Dev, QA, Prod). Within each stage, users can define a sequence of actions including approval tasks, manual interventions, deployment steps, external callouts, and automated test executions—ensuring controlled and auditable releases across the landscape.
Creating a Release Pipeline is a three-step process.
Step 2
Click 'Add Stages' to add the required stages. Add various types of pre-deployment, deployment, and post-deployment tasks as needed.
Step3
Specify the email ids to receive notifications about release pipeline execution status.
Select the required CPI Project.
Navigate to Release and click on the Release Pipelines.
Enter a Pipeline Name.
Click Create New Release Pipeline.
Click Add Stage.
Enter the stage name say for e.g., UAT or QA where the deployment has to be carried out and click OK.
Tasks: Click Add to enter any tasks that are to be performed
Different tasks that can be added are as follows:
All the details pertaining to the deployment of the artifact is specified in the deployment task. The following screen is displayed on adding a deployment task. The various Deployment Actions that can be performed are as follows:
Name
Enter any name of your choice for the approval task being created.
Description
Any message that is to be conveyed for the deployment.
Upload and Deploy
CPI Artifacts are uploaded to design time of the destination environment and published to runtime
Upload Only
CPI Artifacts are uploaded to design time of the destination environment.
Enable Rollback
This will create a backup version of the destination artifact so that you can rollback later.
Notify Users
This option sends an email notification to all users involved in the pipeline when the pipeline is triggered or when specific events occur
Notify Promotion User
When enabled, this option sends an email notification to the user who triggered the promotion (from a user story or release package), regardless of whether the task succeeds or fails.
Schedule Time
You can execute a Release Pipeline either manually or can schedule it to get executed automatically once its reference build pipeline gets executed successfully.
In general, pipeline will execute the configured tasks sequentially one after the other. Wait For Promotion task will be used to stop the execution of the task automatically in the next stage and wait for manual promotion once the user is ready to promote it to the next stage. Tasks waiting for promotion at the same stage of the pipeline can be packaged together as a Release Package and can be promoted to the next stage in the Release Pipeline.
Promotion is the process of Moving/Deploying CPI Artifacts to various environments using a Release pipeline associated with the project.
Pre-requisite for the promotion to work is that every stage in the Release pipeline should end with “Promotion Task”. Promotion can be performed in two ways – via User Story and via Release Package.
a) Promotion by User story
1. From Actions Menu of the User story, promotion can be done. 2. Clicking Promote will Trigger the Release pipeline associated with the project.
3. The column “Pipeline Stage” shows the current stage in the Release Pipeline execution and status of the Release Pipeline.
4. The column “Pipeline Status” shows the current task in the stage or overall status of the Release Pipeline.
5. Runtime view of the pipeline can be viewed using “Pipeline Activity” menu option in the Actions Menu.
6. The pipeline activity screen shows all the stages of the Release Pipeline. Clicking on the stage shows the tasks and it’s execution status.
7. Once Pipeline execution reaches the “Promotion Task” Pipeline will continue to wait until further promotion from the User Story or Release Package.
8. User Story can be promoted to next stage (in this case, Prod) or a new Release Package can be created with all the User Stories waiting in QA stage for getting promoted to Prod.
If a Start Stage is defined, only user stories currently in that stage are eligible for promotion.
The promotion process uses the Release Pipeline associated with the project.
A Release Package is a logical grouping of user stories that are promoted together as a single unit, rather than promoting each story individually.
1. Clicking on “Add stories for promotion” will add all the user stories eligible for promotion.
2. From the Action Menu of the Release package, click on “Promote”.
3. Execution of the Release package can be seen using the option “Pipeline Activity”.
4. Once Promotion for Release package starts then the Release Package will be locked and no changes are possible like addition of more user stories.
5. User has to unlock Release Package to backout any of the user stories after promotion. In role permissions, user should have Unlock Release Package permission.
Validation task is added to perform Static Code Analysis checks and generate the validation report to view the errors encountered. You can continue the execution of the pipeline even upon failure by checking the checkbox – Continue On Failure by fixing the errors seen in the log and re-running the release pipeline.
Field / Option
Description
Name
Enter any name of your choice for the validation task being created. Note: Only letters, numbers, underscores (_), and periods (.) are permitted.
Description
Any message that is to be conveyed to the task approver can be mentioned here.
CPI
Select the respective target environment where validation is to be performed.
Pipeline Execution
Section indicating execution preferences for the task.
Continue on Failure
Checkbox to allow pipeline execution to continue even if validation fails.
Quality Checks
CPI Lint Analysis: Validates integration flows, scripts, and configuration for SAP Integration Suite.
Unit Tests: Executes CPI unit tests to validate business logic.
User Story Dependencies (Beta): Identifies and validates dependent user stories to prevent conflicts or incomplete deployments.
Note: You can select any one or more of the following Quality Checks when configuring the validation task.
The validation report gets generated irrespective of the pipeline execution status - whether success or a failure.
By default, the user who creates the Release Pipeline is notified and specifying the distribution list is optional.
Multi-Stage Release Pipeline
Any number of stages can be added while creating a release pipeline. An existing release pipeline can also be edited to include various stages. This is required when we want the deployments to take place in multiple environments one after the other continuously which is a part of Continuous Delivery.
For each stage, the tasks are to be added separately. This corresponds to the tasks that are to be performed in that particular environment for the deployment to take place and the required actions that are to be taken.
Editing/ Deleting Pipeline
Go to the required pipeline and click Edit to edit the pipeline or Delete to delete the pipeline.
Rollback
Rollback is available for CPI artifacts that are deployed to design time in addition to those published to run time. To rollback a build, click Rollback in the status page.
While creating a release pipeline, you must enable the option to rollback as a prerequisite.
Click rollback in the deployment screen to rollback while running release pipelines.
In the confirmation pop-up that appears, click Yes. Rollback process starts.
Rollback Logs
Rollback Logs are available for CPI artifacts that are deployed to design time in addition to those published to run time. To rollback a build, click Rollback in the status page. Once rollback is enabled, you can see the rollback= status in the deployment logs.
Deploy Logs
Click Deploy Logs to view the logs of the current release pipeline.