Skip to content

Commit ebda697

Browse files
committed
create more subsections
1 parent 55b7324 commit ebda697

File tree

1 file changed

+8
-6
lines changed

1 file changed

+8
-6
lines changed

docs/guides/modules/deploy/pages/configure-deploy-markers.adoc

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,8 @@ To create a deployment marker, you will update your CircleCI configuration file.
2222

2323
You will add commands to plan a deploy and then update its status based on the outcome of your deployment script.
2424

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+
2527
=== 1.1. Plan a deploy
2628

2729
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.
5658
--target-version="1.0.${CIRCLE_BUILD_NUM}-${CIRCLE_SHA1:0:7}"
5759
----
5860
+
59-
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`.
6062

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:
6264
+
6365
[,yml]
6466
----
@@ -67,7 +69,7 @@ This configuraiton would yield a value with the following format `1.0.28853-ffdb
6769
+
6870
This configuration would yield a value with the following format `12345`.
6971

70-
=== 1.2. Update the deploy status
72+
=== 1.2. Update the deploy status to running
7173

7274
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.
7375

@@ -83,8 +85,7 @@ jobs:
8385
- run: circleci run release update --status=running
8486
----
8587

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.
8889

8990
[,yml]
9091
----
@@ -98,7 +99,8 @@ jobs:
9899
- run: circleci run release update <deploy-name> --status=running
99100
----
100101

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.
102104

103105
[,yml]
104106
----

0 commit comments

Comments
 (0)