summaryrefslogtreecommitdiff
path: root/docs/gl_objects
diff options
context:
space:
mode:
authorRaphaƫl Monat <raphael.monat@lip6.fr>2020-12-10 18:33:24 +0100
committerNejc Habjan <hab.nejc@gmail.com>2021-05-29 22:40:51 +0200
commitee9f96e61ab5da0ecf469c21cccaafc89130a896 (patch)
tree1521454c3fa9da89eba68547b5fb9aebb044595e /docs/gl_objects
parent861d3d28ebca719d06bb004556daa12c24ffec72 (diff)
downloadgitlab-ee9f96e61ab5da0ecf469c21cccaafc89130a896.tar.gz
feat(objects): add pipeline test report support
Diffstat (limited to 'docs/gl_objects')
-rw-r--r--docs/gl_objects/pipelines_and_jobs.rst23
1 files changed, 23 insertions, 0 deletions
diff --git a/docs/gl_objects/pipelines_and_jobs.rst b/docs/gl_objects/pipelines_and_jobs.rst
index 0a3ddb1..627af1c 100644
--- a/docs/gl_objects/pipelines_and_jobs.rst
+++ b/docs/gl_objects/pipelines_and_jobs.rst
@@ -326,3 +326,26 @@ Examples
List bridges for the pipeline::
bridges = pipeline.bridges.list()
+
+Pipeline test report
+====================
+
+Get a pipeline's complete test report.
+
+Reference
+---------
+
+* v4 API
+
+ + :class:`gitlab.v4.objects.ProjectPipelineTestReport`
+ + :class:`gitlab.v4.objects.ProjectPipelineTestReportManager`
+ + :attr:`gitlab.v4.objects.ProjectPipeline.test_report`
+
+* GitLab API: https://docs.gitlab.com/ee/api/pipelines.html#get-a-pipelines-test-report
+
+Examples
+--------
+
+Get the test report for a pipeline::
+
+ test_report = pipeline.test_report.get()