summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorAchilleas Pipinellis <axilleas@axilleas.me>2016-07-21 07:49:32 +0000
committerAchilleas Pipinellis <axilleas@axilleas.me>2016-07-21 07:49:32 +0000
commit8ed97054835a28ead703c32d9c2ab79a15412c88 (patch)
treef9bd92afffd5ef1b57be8e752e5e90adb9228800 /doc
parented19b9cc4302572cff435fa4e78eb6dd89d436c6 (diff)
parentd0341bc3ee682a2ef6a4818309b349c1ac7e153e (diff)
downloadgitlab-ce-8ed97054835a28ead703c32d9c2ab79a15412c88.tar.gz
Merge branch 'manual-action-grammar' into 'master'
Improve grammar of manual actions documentation ## What does this MR do? Improve grammar of manual actions documentation ## Are there points in the code the reviewer needs to double check? ## Why was this MR needed? Because people like good grammar. ## What are the relevant issue numbers? ## Screenshots (if relevant) See merge request !5382
Diffstat (limited to 'doc')
-rw-r--r--doc/ci/yaml/README.md20
1 files changed, 11 insertions, 9 deletions
diff --git a/doc/ci/yaml/README.md b/doc/ci/yaml/README.md
index 01b7748e90e..ecca469e4b8 100644
--- a/doc/ci/yaml/README.md
+++ b/doc/ci/yaml/README.md
@@ -485,7 +485,8 @@ failure.
1. `on_failure` - execute build only when at least one build from prior stages
fails.
1. `always` - execute build regardless of the status of builds from prior stages.
-1. `manual` - execute build manually.
+1. `manual` - execute build manually (added in GitLab 8.10). Read about
+ [manual actions](#manual-actions) below.
For example:
@@ -528,21 +529,22 @@ cleanup_job:
The above script will:
-1. Execute `cleanup_build_job` only when `build_job` fails
-2. Always execute `cleanup_job` as the last step in pipeline
-3. Allow you to manually execute `deploy_job` from GitLab
+1. Execute `cleanup_build_job` only when `build_job` fails.
+2. Always execute `cleanup_job` as the last step in pipeline regardless of
+ success or failure.
+3. Allow you to manually execute `deploy_job` from GitLab's UI.
#### Manual actions
>**Note:**
Introduced in GitLab 8.10.
-Manual actions are special type of jobs that are not executed automatically in pipeline.
-They need to be explicitly started by the user.
-Manual actions can be started from pipelines, builds, environments and deployments views.
-You can execute the same manual action multiple times.
+Manual actions are a special type of job that are not executed automatically;
+they need to be explicitly started by a user. Manual actions can be started
+from pipeline, build, environment, and deployment views. You can execute the
+same manual action multiple times.
-Example usage of manual actions is deployment, ex. promote a staging environment to production.
+An example usage of manual actions is deployment to production.
### environment