summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorRémy Coutable <remy@rymai.me>2016-07-19 12:49:54 +0000
committerRémy Coutable <remy@rymai.me>2016-07-19 12:49:54 +0000
commit61e7453e0465ceb631d3e8445429cfed7c1449d3 (patch)
treef20fabfca0a5d7cdf694f1df69c88788b3f8eb65 /doc
parentad14c1bf85f716ed698e8802161de74f462a106c (diff)
parent72229c375fb3efe9dd28c0bf98f0df7696d99fc2 (diff)
downloadgitlab-ce-61e7453e0465ceb631d3e8445429cfed7c1449d3.tar.gz
Merge branch 'manual-actions' into 'master'
Add support for manual CI actions ## What does this MR do? This implements a `when: manual` which allows a jobs to be marked as manual actions. Manual actions have to be explicitly executed by developers. ## What are the relevant issue numbers? This is to solve: https://gitlab.com/gitlab-org/gitlab-ce/issues/17010 See merge request !5297
Diffstat (limited to 'doc')
-rw-r--r--doc/ci/yaml/README.md17
1 files changed, 16 insertions, 1 deletions
diff --git a/doc/ci/yaml/README.md b/doc/ci/yaml/README.md
index 5f77888f631..31b4fd2669e 100644
--- a/doc/ci/yaml/README.md
+++ b/doc/ci/yaml/README.md
@@ -485,6 +485,7 @@ 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.
For example:
@@ -516,6 +517,7 @@ deploy_job:
stage: deploy
script:
- make deploy
+ when: manual
cleanup_job:
stage: cleanup
@@ -527,7 +529,20 @@ 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.
+2. Always execute `cleanup_job` as the last step in pipeline
+3. Allow you to manually execute `deploy_job` from GitLab
+
+#### 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.
+
+Example usage of manual actions is deployment, ex. promote a staging environment to production.
### environment