Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Support
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
G
gitlab-ce
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
0
Issues
0
List
Boards
Labels
Milestones
Merge Requests
0
Merge Requests
0
Analytics
Analytics
Repository
Value Stream
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Commits
Issue Boards
Open sidebar
Boxiang Sun
gitlab-ce
Commits
8c6341a4
Commit
8c6341a4
authored
Nov 26, 2018
by
C.J. Jameson
Committed by
C.J. Jameson
Dec 19, 2018
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Update yaml/README.md to clarify allow_failure interaction with stages
Kudos to @eread for feedback!
parent
347d1633
Changes
2
Hide whitespace changes
Inline
Side-by-side
Showing
2 changed files
with
16 additions
and
8 deletions
+16
-8
changelogs/unreleased/23367-clarify-docs-allow-failure.yml
changelogs/unreleased/23367-clarify-docs-allow-failure.yml
+5
-0
doc/ci/yaml/README.md
doc/ci/yaml/README.md
+11
-8
No files found.
changelogs/unreleased/23367-clarify-docs-allow-failure.yml
0 → 100644
View file @
8c6341a4
---
title
:
Clarifies docs about CI `allow_failure`
merge_request
:
23367
author
:
C.J. Jameson
type
:
other
doc/ci/yaml/README.md
View file @
8c6341a4
...
...
@@ -584,15 +584,17 @@ osx job:
## `allow_failure`
`allow_failure`
is used when you want to allow a job to fail without impacting
the rest of the CI suite. Failed jobs don't contribute to the commit status
.
`allow_failure`
allows a job to fail without impacting the rest of the CI
suite
.
The default value is
`false`
, except for
[
manual
](
#whenmanual
)
jobs.
When enabled and the job fails, the pipeline will be successful/green for all
intents and purposes, but a "CI build passed with warnings" message will be
displayed on the merge request or commit or job page. This is to be used by
jobs that are allowed to fail, but where failure indicates some other (manual)
steps should be taken elsewhere.
When enabled and the job fails, the job will show an orange warning in the UI.
However, the logical flow of the pipeline will consider the job a
success/passed, and is not blocked.
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`
fails, it will not stop the next stage from running, since it's marked with
...
...
@@ -624,7 +626,8 @@ failure.
`when`
can be set to one of the following values:
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
fails.
1.
`always`
- execute job regardless of the status of jobs from prior stages.
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment