From b782358f8d08e727e47e2b8a0226b7a4d8b06f0d Mon Sep 17 00:00:00 2001 From: Grzegorz Bizon Date: Mon, 6 Mar 2017 13:17:49 +0100 Subject: Add some basic docs about blocking manual actions --- doc/ci/yaml/README.md | 17 +++++++++++++++-- 1 file changed, 15 insertions(+), 2 deletions(-) (limited to 'doc/ci/yaml/README.md') 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 > -- cgit v1.2.1 From a004a9743a356597b97cc38103bd193cf6660753 Mon Sep 17 00:00:00 2001 From: Grzegorz Bizon Date: Mon, 6 Mar 2017 14:13:35 +0100 Subject: Highligh info about optional action status in docs --- doc/ci/yaml/README.md | 4 ++++ 1 file changed, 4 insertions(+) (limited to 'doc/ci/yaml/README.md') diff --git a/doc/ci/yaml/README.md b/doc/ci/yaml/README.md index a759fdad96f..fd1171eff7e 100644 --- a/doc/ci/yaml/README.md +++ b/doc/ci/yaml/README.md @@ -563,6 +563,10 @@ 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`. +Optional manual actions have `allow_failure: true` set by default. + +**Statuses of optional actions do not contribute to overall pipeline status.** + > Blocking manual actions were introduced in GitLab 9.0 ### environment -- cgit v1.2.1