summaryrefslogtreecommitdiff
path: root/doc/ci/yaml
diff options
context:
space:
mode:
authorGrzegorz Bizon <grzesiek.bizon@gmail.com>2017-03-06 13:17:49 +0100
committerGrzegorz Bizon <grzesiek.bizon@gmail.com>2017-03-06 13:17:49 +0100
commitb782358f8d08e727e47e2b8a0226b7a4d8b06f0d (patch)
treecd14b51349a884dd0c46b2e92ce365d0abea7a0b /doc/ci/yaml
parent26e1ec0e852bfb99ff697ac8851da7c42efba358 (diff)
downloadgitlab-ce-b782358f8d08e727e47e2b8a0226b7a4d8b06f0d.tar.gz
Add some basic docs about blocking manual actions
Diffstat (limited to 'doc/ci/yaml')
-rw-r--r--doc/ci/yaml/README.md17
1 files changed, 15 insertions, 2 deletions
diff --git a/doc/ci/yaml/README.md b/doc/ci/yaml/README.md
index a586b095ef5..a759fdad96f 100644
--- a/doc/ci/yaml/README.md
+++ b/doc/ci/yaml/README.md
@@ -545,13 +545,26 @@ The above script will:
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.
+from pipeline, build, environment, and deployment views.
An example usage of manual actions is deployment to production.
Read more at the [environments documentation][env-manual].
+Manual actions can be either optional or blocking. Blocking manual action will
+block execution of the pipeline at stage this action is defined in. It is
+possible to resume execution of the pipeline when someone executes a blocking
+manual actions by clicking a _play_ button.
+
+When pipeline is blocked it will not be merged if Merge When Pipeline Succeeds
+is set. Blocked pipelines also do have a special status, called _manual_.
+
+Manual actions are non-blocking by default. If you want to make manual action
+blocking, it is necessary to add `allow_failure: false` to the job's definition
+in `.gitlab-ci.yml`.
+
+> Blocking manual actions were introduced in GitLab 9.0
+
### environment
>