Commit 7b0c5319 authored by Achilleas Pipinellis's avatar Achilleas Pipinellis

Merge branch 'patch-29' into 'master'

Update yaml/README.md to clarify allow_failure interaction with stages

See merge request gitlab-org/gitlab-ce!23367
parents 2a9ba34d 8c6341a4
---
title: Clarifies docs about CI `allow_failure`
merge_request: 23367
author: C.J. Jameson
type: other
...@@ -584,15 +584,17 @@ osx job: ...@@ -584,15 +584,17 @@ osx job:
## `allow_failure` ## `allow_failure`
`allow_failure` is used when you want to allow a job to fail without impacting `allow_failure` allows a job to fail without impacting the rest of the CI
the rest of the CI suite. Failed jobs don't contribute to the commit status. suite.
The default value is `false`, except for [manual](#whenmanual) jobs. The default value is `false`, except for [manual](#whenmanual) jobs.
When enabled and the job fails, the pipeline will be successful/green for all When enabled and the job fails, the job will show an orange warning in the UI.
intents and purposes, but a "CI build passed with warnings" message will be However, the logical flow of the pipeline will consider the job a
displayed on the merge request or commit or job page. This is to be used by success/passed, and is not blocked.
jobs that are allowed to fail, but where failure indicates some other (manual)
steps should be taken elsewhere. Assuming all other jobs are successful, the job's stage and its pipeline will
show the same orange warning. However, the associated commit will be marked
"passed", without warnings.
In the example below, `job1` and `job2` will run in parallel, but if `job1` In the example below, `job1` and `job2` will run in parallel, but if `job1`
fails, it will not stop the next stage from running, since it's marked with fails, it will not stop the next stage from running, since it's marked with
...@@ -624,7 +626,8 @@ failure. ...@@ -624,7 +626,8 @@ failure.
`when` can be set to one of the following values: `when` can be set to one of the following values:
1. `on_success` - execute job only when all jobs from prior stages 1. `on_success` - execute job only when all jobs from prior stages
succeed. This is the default. succeed (or are considered succeeding because they are marked
`allow_failure`). This is the default.
1. `on_failure` - execute job only when at least one job from prior stages 1. `on_failure` - execute job only when at least one job from prior stages
fails. fails.
1. `always` - execute job regardless of the status of jobs from prior stages. 1. `always` - execute job regardless of the status of jobs from prior stages.
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment