Configuring a CI/CD pipeline
Learn how to configure a CI/CD pipeline using the sample scripts provided.
In this section, you can learn how to configure a CI/CD pipeline using either Azure DevOps or GitHub Actions Workflows.
You'll find sample shell scripts and pipeline configurations in the Sample scripts section. These cover both Azure DevOps and GitHub Actions Workflows.
Samples are provided "AS IS" to get you started. Please familiarize yourself with them and feel free to change them to fit your needs.
Why configure a sample CI/CD pipeline?
Umbraco Cloud repositories are not meant as source code repositories. For more information on repositories, see the Repositories in a Cloud Project article.
Once you commit your code to the Cloud, the build pipeline converts your C# code into DLLs and deploys them to the respective environment.
In Umbraco Cloud, only C# code is built. This means that all frontend artifacts need to be built before they are committed to the repository.
You can use Azure DevOps as an external repository, and with the pipelines, it will automatically keep your Azure DevOps source code repository in sync. The sync is done with the git repository of the left-most Umbraco Cloud environment.
Setting Up an Umbraco Cloud Project
Before proceeding, you'll need an Umbraco Cloud project and a CI/CD pipeline. You will also need the required files to add to your pipeline for successful interaction with the Umbraco Cloud API.
Pick an Umbraco Cloud project, preferably with more than one environment (but not a requirement).
Create a new Umbraco Cloud Project.
You can take a trial here.
Create a new project in the Umbraco Cloud Portal.
Use one of your existing projects.
Create a new or an existing CI/CD pipeline in Azure DevOps or GitHub Actions.
In this guide, deployments target the left-most environment in your Umbraco Cloud setup. This means if you have more than one environment, the left-most environment will automatically be selected for deployment. If only a single environment exists, this environment will be used.
Obtaining the Project ID and API Key
To get started with API interactions, you'll need to obtain your Project ID and API key. If you haven't already enabled the CI/CD feature, follow these steps:
Navigate to the Umbraco Cloud Portal and select your project.
Go to
Configuration->CI/CD Flow. This is where you can generate an API key and find your Project ID.
Toggle "Activate CI/CD Flow" to enable the feature.
The API key is tied to the specific project for which it is generated. Ensure to keep it secure in Azure or GitHub, as it will be used for all subsequent API interactions related to that project.
Getting environment aliases to target
With the feature enabled, a button called "CI/CD Environment Targets" becomes available. Clicking the button opens a modal with your environments and their aliases.
Next to the environment alias is a button you can click to copy the alias.
If the alias is greyed out, it is currently not a valid target through the Umbraco CI/CD flow API.
Currently, flexible environments and the left-most environment are considered valid targets.
The impact of allowing CI/CD deployments to all environments is being investigated.
Sample pipelines
Below are a couple of examples on how to set up a CI/CD Pipeline using either Azure DevOps or GitHub Actions.
Each guide describes:
How to set up a new repository in either GitHub or Azure DevOps.
How to get a copy of your Umbraco Cloud project into that repository.
How to configure a new pipeline using the provided samples.
The sample pipelines use either Bash or PowerShell scripts to facilitate communication with the Umbraco CI/CD API.
During the guides, you will have the option to choose between PowerShell or Bash scripts. You can select the scripting technology you feel most comfortable with.
Azure DevOps sample
Covers setting up a CI/CD pipeline using Azure DevOps.
GitHub Actions sample
Covers setting up a CI/CD pipeline using GitHub Actions.
Samples for version 1
If you are using version 1 endpoints, use the guides referenced below:
Last updated
Was this helpful?