--- title: Set Up a CI/CD Pipeline for SAP BTP, Cloud Foundry Runtime description: This section describes how to configure and run a predefined continuous integration and delivery (CI/CD) pipeline that automatically tests, builds, and deploys your code changes to speed up your development and delivery cycles. keywords: cap parser: v2 auto_validation: true time: 30 tags: [ tutorial>beginner, software-product-function>sap-cloud-application-programming-model, programming-tool>node-js, software-product>sap-business-technology-platform, software-product>sap-fiori] primary_tag: software-product-function>sap-cloud-application-programming-model author_name: Svetoslav Pandeliev author_profile: https://github.com/slavipande slug: set-up-cicd canonical_url: https://developers.sap.com/tutorials/set-up-cicd --- ## You will learn - How to initialize a repository in SAP Business Application Studio. - How to set up your CI/CD pipeline. ## Prerequisites - You've prepared your application for deployment in SAP BTP, Cloud Foundry runtime. Follow the steps in the [Deploy in SAP BTP, Cloud Foundry Runtime](deploy-to-cf) tutorial that is part of the [Deploy a Full-Stack CAP Application in SAP BTP, Cloud Foundry Runtime Following SAP BTP Developer’s Guide](https://developers.sap.com/group.deploy-full-stack-cap-application.html) tutorial group. - You have an [enterprise global account](https://help.sap.com/docs/btp/sap-business-technology-platform/getting-global-account#loiod61c2819034b48e68145c45c36acba6e) in SAP BTP. To use services for free, you can sign up for an SAP BTPEA (SAP BTP Enterprise Agreement) or a Pay-As-You-Go for SAP BTP global account and use the free tier services only. See [Using Free Service Plans](https://help.sap.com/docs/btp/sap-business-technology-platform/using-free-service-plans?version=Cloud). - You have a platform user. See [User and Member Management](https://help.sap.com/docs/btp/sap-business-technology-platform/user-and-member-management). - You're an administrator of the global account in SAP BTP. - You have a subaccount in SAP BTP to deploy the services and applications. - You have one of the following browsers that are supported for working in SAP Business Application Studio: - Mozilla Firefox - Google Chrome - Microsoft Edge > **OUT OF MAINTENANCE** > > This tutorial is no longer maintained. For an up-to-date version and support with any issues, refer to the [Develop a Full-Stack CAP Application Following the SAP BTP Developer's Guide](https://discovery-center.cloud.sap/missiondetail/4327/4608/) mission in the [SAP Discovery Center](https://discovery-center.cloud.sap/). ### Create a repository To be able to perform the steps for setting up a CI/CD pipeline, you need a public repository. Currently, SAP Continuous Integration and Delivery supports [GitHub](https://github.com/) and [Bitbucket](https://bitbucket.org/) repositories. For real application development, you need to consider the right place for your repository. In this example, we're creating a repository on GitHub. You need a [GitHub](https://github.com/) account for this step. Go ahead and create one if you don't have it yet. 1. Create a new GitHub repository in your GitHub account. 1. Under **Repository name**, enter **incident-management**. 2. Choose **Create repository**. ![Create repository](https://raw.githubusercontent.com/sap-tutorials/btp-dev-guidance/main/tutorials/set-up-cicd/create-repo.png) 3. You're directed to the **Quick Setup** page of your new repository. Make sure to copy the URL of the repository as you'll need it in the next steps. ![Quick Setup](https://raw.githubusercontent.com/sap-tutorials/btp-dev-guidance/main/tutorials/set-up-cicd/quick-setup.png) ### Initialize a repository in SAP Business Application Studio 1. In SAP Business Application Studio, navigate to **Source Control** and choose **Initialize Repository**. ![Initialize repository](https://raw.githubusercontent.com/sap-tutorials/btp-dev-guidance/main/tutorials/set-up-cicd/initialize-repo.png) 2. In the dropdown **Pick workspace folder to initialize git repo in**, choose the **incident-management** folder. ![Pick workspace folder](https://raw.githubusercontent.com/sap-tutorials/btp-dev-guidance/main/tutorials/set-up-cicd/pick-workspace-folder.png) 3. Open the three dots menu next to **Source Control** and choose **Remote** → **Add Remote...**. ![Add remote](https://raw.githubusercontent.com/sap-tutorials/btp-dev-guidance/main/tutorials/set-up-cicd/add-remote.png) 4. Paste the URL of your repository in the **Provide repository URL** field and press Enter. ![Provide repo URL](https://raw.githubusercontent.com/sap-tutorials/btp-dev-guidance/main/tutorials/set-up-cicd/provide-repo-url.png) 5. Provide a remote name and press Enter. ![Provide remote name](https://raw.githubusercontent.com/sap-tutorials/btp-dev-guidance/main/tutorials/set-up-cicd/provide-remote-name.png) 6. Stage your changes, add a commit message, and choose **Publish Branch**. ![Publish branch](https://raw.githubusercontent.com/sap-tutorials/btp-dev-guidance/main/tutorials/set-up-cicd/publish-branch.png) 7. Provide your GitHub username and password when prompted. When the changes are pushed, you see your project in your GitHub repository. ### Enable SAP Continuous Integration and Delivery Service 1. Navigate to your subaccount and choose **Services** → **Service Marketplace** on the left. 4. Type **Continuous Integration & Delivery** in the search box and choose **Create**. ![Continuous Integration and Delivery create service](https://raw.githubusercontent.com/sap-tutorials/btp-dev-guidance/main/tutorials/set-up-cicd/cicd-create-service.png) 6. Choose **Create** in the **New Instance or Subscription** popup without changing any values. ![New Instance or Subscription popup](https://raw.githubusercontent.com/sap-tutorials/btp-dev-guidance/main/tutorials/set-up-cicd/cicd-create-service-popup.png) 7. Choose **View Subscription** and wait until the status changes to **Subscribed**. ![View subscription](https://raw.githubusercontent.com/sap-tutorials/btp-dev-guidance/main/tutorials/set-up-cicd/cicd-view-subscription.png) ![Status subscribed](https://raw.githubusercontent.com/sap-tutorials/btp-dev-guidance/main/tutorials/set-up-cicd/cicd-status-subscribed.png) 8. In your SAP BTP subaccount, choose **Security** → **Role Collections** in the left-hand pane. 9. Choose role collection **CICD Service Administrator**. 10. Choose **Edit**. ![Edit role](https://raw.githubusercontent.com/sap-tutorials/btp-dev-guidance/main/tutorials/set-up-cicd/cicd-edit-role.png) 11. In the **Users** section, enter your user and select the icon to add the user. ![Add user](https://raw.githubusercontent.com/sap-tutorials/btp-dev-guidance/main/tutorials/set-up-cicd/cicd-add-user.png) > Keep the setting `Default Identity Provider` unless you have a custom identity provider configured. 13. Choose **Save**. You've assigned the **CICD Service Administrator** role collection to your user. > Log out and log back in to make sure your new role collection is considered. > See [Initial Setup](https://help.sap.com/docs/CONTINUOUS_DELIVERY/99c72101f7ee40d0b2deb4df72ba1ad3/719acaf61e4b4bf0a496483155c52570.html) for more details on how to enable the service. ### Access SAP Continuous Integration and Delivery Service 1. In your SAP BTP subaccount, navigate to **Services** → **Instances and Subscriptions** in the left-hand pane. 2. Choose **Continuous Integration & Delivery**. ![CI/CD Go to application](https://raw.githubusercontent.com/sap-tutorials/btp-dev-guidance/main/tutorials/set-up-cicd/cicd-goto-app.png) 3. Use your SAP BTP global user name and global password to log in to the application. ### Add Credentials 1. Choose the **Credentials** tab and choose the icon to add a new credential. ![Add new credential](https://raw.githubusercontent.com/sap-tutorials/btp-dev-guidance/main/tutorials/set-up-cicd/add-credential.png) 2. Under **Create Credentials** on the right: - Enter **github** in the **Credential Name** field. - Choose **Basic Authentication** from the dropdown in the **Type** field. - Enter your GitHub user name in the **Username** field. - Enter your GitHub personal access token in the **Password** field. - Choose **Create**. > See [Create a Credential for a Private GitHub Repository](https://help.sap.com/docs/continuous-integration-and-delivery/sap-continuous-integration-and-delivery/create-credential-for-private-github-repository?language=en-US) for instructions on how to create a GitHub personal access token if you don't have one. ![Create GitHub credential](https://raw.githubusercontent.com/sap-tutorials/btp-dev-guidance/main/tutorials/set-up-cicd/create-github-credential.png) 3. Choose the icon to add a new credential again and create a credential for Cloud Foundry: - Enter **cf** in the **Credential Name** field. - Choose **Basic Authentication** from the dropdown in the **Type** field. - Enter your SAP BTP global user name in the **Username** field. - Enter your SAP BTP global password in the **Password** field. - Choose **Create**. ![configure pipeline](https://raw.githubusercontent.com/sap-tutorials/btp-dev-guidance/main/tutorials/set-up-cicd/create-cf-credential.png) ### Add a CI/CD job 1. Navigate to the **Jobs** tab and choose the icon to add a new job. ![Add new job](https://raw.githubusercontent.com/sap-tutorials/btp-dev-guidance/main/tutorials/set-up-cicd/add-job.png) 2. Enter **Incident-Management** in the **Job Name** field. #### Add repository 1. Open the value help for the **Repository** field. ![Add job name](https://raw.githubusercontent.com/sap-tutorials/btp-dev-guidance/main/tutorials/set-up-cicd/job-name.png) 2. In the **Select Repository** popup, choose **Add Repository**. A popup opens. ![Select Repository popup](https://raw.githubusercontent.com/sap-tutorials/btp-dev-guidance/main/tutorials/set-up-cicd/select-repository.png) 3. In the **Add Repository** popup, enter details for the repository you created in **Step 1: Create a repository**: - Enter **incident-management** in the **Name** field. - Enter your repository's URL in the **Clone URL** field. - Open the value help in the **Credentials** field and choose the credential **github** that you created in **Step 5: Add credentials**. - Select **GitHub** from the dropdown in the **Type** field. ![Add Repository popup](https://raw.githubusercontent.com/sap-tutorials/btp-dev-guidance/main/tutorials/set-up-cicd/add-repository.png) #### Create credentials 1. Open the value help in the **Webhook Credential** field. ![Create Webhook value help](https://raw.githubusercontent.com/sap-tutorials/btp-dev-guidance/main/tutorials/set-up-cicd/webhook-value-help.png) 2. In the **Select Credentials** popup, choose **Create Credentials**. ![Select Credentials popup](https://raw.githubusercontent.com/sap-tutorials/btp-dev-guidance/main/tutorials/set-up-cicd/select-credentials.png) 3. In the **Create Credentials** popup: - Enter **webhook** in the **Credentials Name** field. - Click **Generate** next to the **Secret** field to create a secret. - Copy the generated secret from the **Secret** field and save it. You need it in **Step 7: Create a GitHub webhook**. - Choose **Create**. ![Create webhook](https://raw.githubusercontent.com/sap-tutorials/btp-dev-guidance/main/tutorials/set-up-cicd/create-webhook.png) 4. Go back in the **Add Repository** popup and choose **Add** to complete the addition of a repository. ![Complete repo addition](https://raw.githubusercontent.com/sap-tutorials/btp-dev-guidance/main/tutorials/set-up-cicd/complete-repo-add.png) #### Configure pipeline and stages [OPTION BEGIN [Node.js]] 1. Back in the **General Information** tab, enter **main** in the **Branch** field. 2. Select **Cloud Foundry Environment** from the dropdown in the **Pipeline** field. ![Configure pipeline](https://raw.githubusercontent.com/sap-tutorials/btp-dev-guidance/main/tutorials/set-up-cicd/configure-pipeline.png) 3. In the **Stages** section, select **mta** from the dropdown in the **Build Tool** field. 4. Select the latest Java and Node version from the dropdown in the **Build Tool Version** field. ![Configure stages](https://raw.githubusercontent.com/sap-tutorials/btp-dev-guidance/main/tutorials/set-up-cicd/configure-stages.png) #### Add unit tests and configure release 1. In the **Additional Unit Tests** section, switch the toggle button to **ON**. 2. Enter **test** in the **npm Script** field. ![Add unit tests](https://raw.githubusercontent.com/sap-tutorials/btp-dev-guidance/main/tutorials/set-up-cicd/add-unit-tests.png) 3. In the **Release** section, switch the toggle **Deploy to Cloud Foundry Space** to **ON**. 4. Provide the required information for your account and complete the job creation: - Enter the URL of your API endpoint in the **API Endpoint** field. - Enter the name of your Cloud Foundry organisation in the **Org Name** field. - Enter the name of your development space in the **Space** field. > You can get the values from your subaccount's **Overview** page in the SAP BTP cockpit. - Select **standard** from the dropdown in the **Deploy Type** field. - Open the value help in the **Credentials** field and choose the credential **cf** that you created in **Step 5: Add credentials**. - Choose **Create**. ![Configure release](https://raw.githubusercontent.com/sap-tutorials/btp-dev-guidance/main/tutorials/set-up-cicd/configure-release.png) [OPTION END] [OPTION BEGIN [Java]] 1. Back in the **General Information** tab, enter **main** in the **Branch** field. 2. Select **Cloud Foundry Environment** from the dropdown in the **Pipeline** field. ![Configure pipeline](https://raw.githubusercontent.com/sap-tutorials/btp-dev-guidance/main/tutorials/set-up-cicd/configure-pipeline.png) 3. In the **Stages** section, select **mta** from the dropdown in the **Build Tool** field. 4. Select the latest Java and Node version from the dropdown in the **Build Tool Version** field. ![Configure stages](https://raw.githubusercontent.com/sap-tutorials/btp-dev-guidance/main/tutorials/set-up-cicd/configure-stages-java.png) #### Configure release 3. In the **Release** section, switch the toggle **Deploy to Cloud Foundry Space** to **ON**. 4. Provide the required information for your account and complete the job creation: - Enter the URL of your API endpoint in the **API Endpoint** field. - Enter the name of your Cloud Foundry organisation in the **Org Name** field. - Enter the name of your development space in the **Space** field. > You can get the values from your subaccount's **Overview** page in the SAP BTP cockpit. - Select **standard** from the dropdown in the **Deploy Type** field. - Open the value help in the **Credentials** field and choose the credential **cf** that you created in **Step 5: Add credentials**. - Choose **Create**. ![Configure release](https://raw.githubusercontent.com/sap-tutorials/btp-dev-guidance/main/tutorials/set-up-cicd/configure-release.png) [OPTION END] ### Create a GitHub webhook 1. Navigate to the **Repositories** tab and choose the **incident-management** repository that you created. Under the **Webhook Event Receiver** tab, choose **Webhook Data**. ![Incident-Management repo](https://raw.githubusercontent.com/sap-tutorials/btp-dev-guidance/main/tutorials/set-up-cicd/incident-management-repo.png) 2. In the **Webhook Creation** popup, find the **Payload URL** field and copy its value. ![Webhook Data popup](https://raw.githubusercontent.com/sap-tutorials/btp-dev-guidance/main/tutorials/set-up-cicd/webhook-data.png) 3. Go to your repository on GitHub and open the **Settings** tab. 4. From the navigation pane on the left, choose **Webhooks** → **Add webhook**. ![Add webhook](https://raw.githubusercontent.com/sap-tutorials/btp-dev-guidance/main/tutorials/set-up-cicd/add-webhook.png) 5. Insert the data for your webhook: - Paste the **incident-management** repository's payload URL that you copied from the **Webhook Creation** popup in the **Payload URL** field. - Select **application/json** from the dropdown in the **Content type** field. - Paste the secret that you created in **Step 6: Add a CI/CD job** in the **Secret** field. - Under **Which events would you like to trigger this webhook**, select **Just the push event**. - Choose **Add webhook**. ![Configure webhook](https://raw.githubusercontent.com/sap-tutorials/btp-dev-guidance/main/tutorials/set-up-cicd/configure-webhook.png) ### Test your job 1. You have to trigger your job manually the first time after creation. Go back to the **SAP Continuous Integration and Delivery** application and navigate to the **Jobs** tab. 2. Choose the **Incident-Management** job and choose **Run**. ![Run job](https://raw.githubusercontent.com/sap-tutorials/btp-dev-guidance/main/tutorials/set-up-cicd/run-job.png) 3. Verify that a new tile appears in the **Builds** view. This tile is marked as running. ![Build running](https://raw.githubusercontent.com/sap-tutorials/btp-dev-guidance/main/tutorials/set-up-cicd/build-running.png) 4. Wait until the job has finished and verify that the build tile is marked as successful. ![Build successful](https://raw.githubusercontent.com/sap-tutorials/btp-dev-guidance/main/tutorials/set-up-cicd/build-successful.png)