summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--changelogs/unreleased/docs-for-failure-reason-tooltip.yml5
-rw-r--r--doc/ci/img/job_failure_reason.pngbin0 -> 5346 bytes
-rw-r--r--doc/ci/pipelines.md16
3 files changed, 21 insertions, 0 deletions
diff --git a/changelogs/unreleased/docs-for-failure-reason-tooltip.yml b/changelogs/unreleased/docs-for-failure-reason-tooltip.yml
new file mode 100644
index 00000000000..ef37654b189
--- /dev/null
+++ b/changelogs/unreleased/docs-for-failure-reason-tooltip.yml
@@ -0,0 +1,5 @@
+---
+title: Add documentation for Pipelines failure reasons
+merge_request: 18352
+author:
+type: other
diff --git a/doc/ci/img/job_failure_reason.png b/doc/ci/img/job_failure_reason.png
new file mode 100644
index 00000000000..a60ce1fb21c
--- /dev/null
+++ b/doc/ci/img/job_failure_reason.png
Binary files differ
diff --git a/doc/ci/pipelines.md b/doc/ci/pipelines.md
index 301cccc80a3..f14e0527998 100644
--- a/doc/ci/pipelines.md
+++ b/doc/ci/pipelines.md
@@ -73,6 +73,21 @@ cancel the job, retry it, or erase the job trace.
![Pipelines example](img/pipelines.png)
+## Seeing the failure reason for jobs
+
+> [Introduced][ce-5742] in GitLab 10.7.
+
+When a pipeline fails or is allowed to fail, there are several places where you
+can quickly check the reason it failed:
+
+- **In the pipeline graph** present on the pipeline detail view.
+- **In the pipeline widgets** present in the merge requests and commit pages.
+- **In the job views** present in the global and detailed views of a job.
+
+In any case, if you hover over the failed job you can see the reason it failed.
+
+![Pipeline detail](img/job_failure_reason.png)
+
## Pipeline graphs
> [Introduced][ce-5742] in GitLab 8.11.
@@ -263,4 +278,5 @@ runners will not use regular runners, they must be tagged accordingly.
[ce-6242]: https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/6242
[ce-7931]: https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/7931
[ce-9760]: https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/9760
+[ce-17782]: https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/17782
[regexp]: https://gitlab.com/gitlab-org/gitlab-ce/blob/2f3dc314f42dbd79813e6251792853bc231e69dd/app/models/commit_status.rb#L99