summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLucas Charles <me@lucascharles.me>2019-06-18 16:47:25 +0000
committerLucas Charles <me@lucascharles.me>2019-06-18 16:47:25 +0000
commit1899d7ce06fa34e3748b066c86805e4775d671c9 (patch)
tree4a4349664b6dcdf93a250a68aa1b77200f3aa96c
parent319a44886034276d430df5afe262d5afb806db20 (diff)
downloadgitlab-ce-patch-70.tar.gz
Update CI `retry` docs to clarify when conditionspatch-70
-rw-r--r--doc/ci/yaml/README.md5
1 files changed, 4 insertions, 1 deletions
diff --git a/doc/ci/yaml/README.md b/doc/ci/yaml/README.md
index 2759f1c5160..7400a1a762a 100644
--- a/doc/ci/yaml/README.md
+++ b/doc/ci/yaml/README.md
@@ -1714,13 +1714,16 @@ Possible values for `when` are:
- `always`: Retry on any failure (default).
- `unknown_failure`: Retry when the failure reason is unknown.
-- `script_failure`: Retry when the script failed.
+- `script_failure`: Retry when the script exited with a non-zero code.
- `api_failure`: Retry on API failure.
- `stuck_or_timeout_failure`: Retry when the job got stuck or timed out.
- `runner_system_failure`: Retry if there was a runner system failure (e.g. setting up the job failed).
- `missing_dependency_failure`: Retry if a dependency was missing.
- `runner_unsupported`: Retry if the runner was unsupported.
+*Note:* `script_failure` is the only failure reason that can be reported when the job itself has failed.
+All other reasons are related to Runner or GitLab internals involved in execution of the job.
+
### `parallel`
> [Introduced](https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/22631) in GitLab 11.5.