You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/guides/modules/deploy/pages/configure-deploy-markers.adoc
+8-6Lines changed: 8 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -22,6 +22,8 @@ To create a deployment marker, you will update your CircleCI configuration file.
22
22
23
23
You will add commands to plan a deploy and then update its status based on the outcome of your deployment script.
24
24
25
+
NOTE: The `circleci run release` commands are only available in CircleCI builds and are not part of the CircleCI local CLI. You do not need to install the CircleCI local CLI in your CircleCI pipeline to use these commands.
26
+
25
27
=== 1.1. Plan a deploy
26
28
27
29
Add a `circleci run release plan` command to your deployment job. This tells CircleCI to plan a new deploy and show it in the link:https://app.circleci.com/deploys[Deploys UI] with `pending` status.
@@ -56,9 +58,9 @@ This section provides some options for setting the `target-version` parameter.
This configuraiton would yield a value with the following format `1.0.28853-ffdbeb1`.
61
+
This configuration would yield a value with the following format `1.0.28853-ffdbeb1`.
60
62
61
-
* Anothe option is to use pipeline values. For example you could define the target version as follows:
63
+
* Another option is to use pipeline values. For example you could define the target version as follows:
62
64
+
63
65
[,yml]
64
66
----
@@ -67,7 +69,7 @@ This configuraiton would yield a value with the following format `1.0.28853-ffdb
67
69
+
68
70
This configuration would yield a value with the following format `12345`.
69
71
70
-
=== 1.2. Update the deploy status
72
+
=== 1.2. Update the deploy status to running
71
73
72
74
After deploying your application, you can update the status of the deployment to `RUNNING` by running the `circleci run release update` command in a new step.
73
75
@@ -83,8 +85,7 @@ jobs:
83
85
- run: circleci run release update --status=running
84
86
----
85
87
86
-
If you are deploying multiple components or to multiple environments from a single workflow, you need to provide the command with a deployment name.
87
-
This value should match the value you provided when you planned the deploy.
88
+
If you are deploying multiple components or to multiple environments from a single workflow, you need to provide the command with a deployment name. The deploy name value should match the value you provided when you planned the deploy.
88
89
89
90
[,yml]
90
91
----
@@ -98,7 +99,8 @@ jobs:
98
99
- run: circleci run release update <deploy-name> --status=running
99
100
----
100
101
101
-
Now you can use the `when` attribute to add `on_success` and `on_failure` steps at the end of your deployment job, to handle the final status update of the deploy.
102
+
=== 1.3. Update the deploy status to success or failure
103
+
You can use the `when` attribute to add `on_success` and `on_failure` steps at the end of your deployment job, to handle the final status update of the deploy.
0 commit comments