Skip to content

Commit 31df00a

Browse files
Sofie Toft Kristensengitbook-bot
authored andcommitted
GITBOOK-102: No subject
1 parent 9ec5666 commit 31df00a

File tree

2 files changed

+19
-10
lines changed

2 files changed

+19
-10
lines changed

umbraco-cloud/set-up/project-settings/umbraco-cicd/samplecicdpipeline/azure-devops.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,10 +13,14 @@ Before setting up the pipeline in Azure DevOps, make sure that the following ste
1313

1414
Next, you will need to define your pipeline in YAML and use it to interact with the Umbraco Cloud API.
1515

16+
{% hint style="info" %}
17+
Are you using version 1? Follow the [guide for Azure DevOps v1 instead](azure-devops-v1.md).
18+
{% endhint %}
19+
1620
{% hint style="info" %}
1721
The Umbraco CI/CD Team has created a sample pipeline for Azure DevOps.
1822

19-
The Scripts are provided as is. This means that the scripts will do the bare minimum for a pipeline that is utilizing the CI/CD flow. 
23+
The Scripts are provided as is. This means that the scripts will do the bare minimum for a pipeline that is utilizing the CI/CD flow.
2024

2125
You'll need to adapt and integrate the script into your own pipelines to gain the ability to do deployments to your Umbraco Cloud projects.
2226

@@ -174,7 +178,7 @@ It is recommended to handle the `API Key` as a secret. This can be done by ticki
174178
You can customize the names for the variables as you like, however, you then need to rename the affected variables in `azure-release-pipeline.yaml`.
175179

176180
Check the references to the variables in the yaml files match the variable syntaxes in the created variable. Example: `umbracoCloudApiKey` = `UMBRACOCLOUDAPIKEY`.
177-
{% endhint %}
181+
{% endhint %}
178182

179183
When you click on "Save and Run" your first deployment will be triggered. Which means that Azure DevOps is set up with all the needed information to be able to deploy your Cloud project back to Umbraco Cloud.
180184

@@ -191,7 +195,7 @@ While working on your project locally, add a new Document type.
191195

192196
## High level overview of the pipeline components
193197

194-
The mentioned scripts are provided as a starting point.
198+
The mentioned scripts are provided as a starting point.\
195199
It is recommended that you familiarize yourself with the scripts and with documentation related to how to use Azure DevOps.
196200

197201
The scripts demonstrates the following:
@@ -206,7 +210,7 @@ The `azure-release-pipeline.yaml` is the main pipeline, and is the one that will
206210

207211
You can add your Build and Test stage between the `cloudSyncStage` and `cloudPrepareArtifact` stages. Keep in mind that you do not need to retain the dotnet build artifact for upload later. The `cloudPrepareArtifact` job will take care of packaging all your source code and upload to Umbraco Cloud.
208212

209-
Make sure that you checkout the potentially updated code if you add Build and Test steps.
213+
Make sure that you checkout the potentially updated code if you add Build and Test steps.
210214

211215
### Cloud-sync
212216

@@ -216,7 +220,7 @@ If you don't want the pipeline to commit back to the triggering branch, this is
216220

217221
### Cloud-artifact
218222

219-
The `cloud-artifact.yml` shows how you can prepare and package an artifact and finally upload it to Umbraco Cloud.
223+
The `cloud-artifact.yml` shows how you can prepare and package an artifact and finally upload it to Umbraco Cloud.
220224

221225
There are a couple of things here to be aware of:
222226

umbraco-cloud/set-up/project-settings/umbraco-cicd/samplecicdpipeline/github-actions.md

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,10 +13,14 @@ Before setting up the pipeline in GitHub, make sure that the following steps fro
1313

1414
Next, you will need to define your pipeline in YAML and use it to interact with the Umbraco Cloud API.
1515

16+
{% hint style="info" %}
17+
Are you using version 1? Follow the [guide for GitHub Actions version 1](github-actions-v1.md).
18+
{% endhint %}
19+
1620
{% hint style="info" %}
1721
The Umbraco CI/CD Team has created a sample pipeline for GitHub Actions.
1822

19-
The Scripts are provided as is. This means that the scripts will do the bare minimum for a pipeline that is utilizing the CI/CD flow. 
23+
The Scripts are provided as is. This means that the scripts will do the bare minimum for a pipeline that is utilizing the CI/CD flow.
2024

2125
You'll need to adapt and integrate the script into your own pipelines to gain the ability to do deployments to your Umbraco Cloud projects.
2226

@@ -75,6 +79,7 @@ You will also need the alias of the environment you want to target. [This articl
7579
* Create another `repository secret` with the name `PROJECT_ID` and the `Project ID` value from the Umbraco Portal.
7680

7781
Now go to the **Variables** tab
82+
7883
* Create a `repository variable` called `TARGET_ENVIRONMENT_ALIAS` and enter the environment alias you selected earlier.
7984

8085
{% hint style="info" %}
@@ -104,7 +109,7 @@ jobs:
104109
umbracoCloudApiKey: ${{ secrets.UMBRACO_CLOUD_API_KEY }} # change the part inside the curly braces
105110
with:
106111
targetEnvironmentAlias: ${{ vars.TARGET_ENVIRONMENT_ALIAS }} # change the part inside the curly braces
107-
```
112+
```
108113
{% endhint %}
109114
110115
Now GitHub is set up with the needed information to be able to run a deployment back to Umbraco Cloud.
@@ -220,7 +225,7 @@ While working on your project locally, add a new Document type.
220225

221226
## High level overview of the pipeline components
222227

223-
The mentioned scripts are provided as a starting point.
228+
The mentioned scripts are provided as a starting point.\
224229
It is recommended that you familiarize yourself with the scripts and with documentation related to how to use GitHub Actions.
225230

226231
The scripts demonstrates the following:
@@ -235,7 +240,7 @@ The `main.yml` is the main pipeline, and is the one that will be triggered on a
235240

236241
You can add your Build and Test jobs between the `cloud-sync` and `cloud-artifact` jobs. Keep in mind that you do not need to retain the dotnet build artifact for upload later. The `cloud-artifact` job will take care of packaging all your source code and upload to Umbraco Cloud.
237242

238-
Make sure that you checkout the potentially updated code if you add Build and Test steps.
243+
Make sure that you checkout the potentially updated code if you add Build and Test steps.
239244

240245
### Cloud-sync
241246

@@ -245,7 +250,7 @@ If you don't want the pipeline to commit back to the triggering branch, this is
245250

246251
### Cloud-artifact
247252

248-
The `cloud-artifact.yml` shows how you can prepare and package an artifact and finally upload it to Umbraco Cloud.
253+
The `cloud-artifact.yml` shows how you can prepare and package an artifact and finally upload it to Umbraco Cloud.
249254

250255
There are a couple of things here to be aware of:
251256

0 commit comments

Comments
 (0)