Skip to content

Fix Vale errors in configure-deploy-markers.adoc #10301

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
rosieyohannan wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Fix Vale errors in configure-deploy-markers.adoc #10301

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions docs/guides/modules/deploy/pages/configure-deploy-markers.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -169,10 +169,10 @@ jobs:

In this example, note the following flags and options:

* The `<deploy-name>` argument is used to identify the deployment. `deploy-name` is an arbitrary positional argument that will be used to identify the deployment and should be unique within the workflow. If not specified, the deployment name will be set to `default`. 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>` argument is used to identify the deployment. `deploy-name` is an arbitrary positional argument that will be used to identify the deployment and must be unique within the workflow. If not specified, the deployment name will be set to `default`. 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 `--environment-name` flag sets the target environment. If the specified environment does not exist, it will be created. If you do not specify an environment, CircleCI will create one named `default`.
* The `--component-name` flag sets the name that will be displayed in the Deploys UI. If you do not already have a component in your project a new one will be created with the name of the project. This will be set as the component that is being deployed.
* The `--target-version` flag should match the version being deployed. Some examples are provided <<examples-for-target-version,in the next section>>.
* The `--target-version` flag must match the version being deployed. Some examples are provided <<examples-for-target-version,in the next section>>.
* The `--namespace` flag is optional and can be provided to use a value other than `default`.

Configuring `circleci run release plan` identifies the deployment you are planning so that you can reference it to update its status later on.
Expand Down Expand Up @@ -206,7 +206,7 @@ WARNING: The `circleci run release update` command is only for use with deploy m

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.

If you specified a `deploy-name` when _planning_ your deploy, remember to provide your deploy name when using the `update` commands too. The deploy name value should match the value you provided when you planned the deploy. If you did not provide a deploy name when you planned the deploy, it will be set to `default` and you do not need to provide it when updating the status.
If you specified a `deploy-name` when _planning_ your deploy, remember to provide your deploy name when using the `update` commands too. The deploy name value must match the value you provided when you planned the deploy. If you did not provide a deploy name when you planned the deploy, it will be set to `default` and you do not need to provide it when updating the status.

.Update the deploy status to running
[,yml]
Expand Down Expand Up @@ -408,7 +408,7 @@ jobs:

** The `--environment-name` flag specifies the target environment. If the environment does not exist, it will be created.
** The `--component-name` flag sets the name that will be displayed in the CircleCI UI.
** The `--target-version` flag should match the name of the version being deployed. Some examples are provided <<examples-for-target-version,above>>.
** The `--target-version` flag matches the name of the version being deployed. Some examples are provided <<examples-for-target-version,above>>.
** (Optional) You can provide the following parameter if required:
*** The `--namespace` flag can be provided to use a value other than `default`.

Expand Down