summaryrefslogtreecommitdiff
path: root/docs/gl_objects
diff options
context:
space:
mode:
authorNejc Habjan <hab.nejc@gmail.com>2021-02-24 00:18:49 +0100
committerNejc Habjan <hab.nejc@gmail.com>2021-06-13 21:18:44 +0200
commit954357c49963ef51945c81c41fd4345002f9fb98 (patch)
tree13cd0da13d9a747cae56eff45fe27244f3c13a51 /docs/gl_objects
parente3aa0238da48589d41c84e3102611eb21d032ea5 (diff)
downloadgitlab-954357c49963ef51945c81c41fd4345002f9fb98.tar.gz
feat(api): add MR pipeline manager in favor of pipelines() method
Diffstat (limited to 'docs/gl_objects')
-rw-r--r--docs/gl_objects/mrs.rst29
1 files changed, 25 insertions, 4 deletions
diff --git a/docs/gl_objects/mrs.rst b/docs/gl_objects/mrs.rst
index be93f12..29cbced 100644
--- a/docs/gl_objects/mrs.rst
+++ b/docs/gl_objects/mrs.rst
@@ -127,10 +127,6 @@ List the changes of a MR::
changes = mr.changes()
-List the pipelines for a MR::
-
- pipelines = mr.pipelines()
-
List issues that will close on merge::
mr.closes_issues()
@@ -185,3 +181,28 @@ Get user agent detail for the issue (admin only)::
Attempt to rebase an MR::
mr.rebase()
+
+Merge Request Pipelines
+=======================
+
+Reference
+---------
+
+* v4 API:
+
+ + :class:`gitlab.v4.objects.ProjectMergeRequestPipeline`
+ + :class:`gitlab.v4.objects.ProjectMergeRequestPipelineManager`
+ + :attr:`gitlab.v4.objects.ProjectMergeRequest.pipelines`
+
+* GitLab API: https://docs.gitlab.com/ee/api/merge_requests.html#list-mr-pipelines
+
+Examples
+--------
+
+List pipelines for a merge request::
+
+ pipelines = mr.pipelines.list()
+
+Create a pipeline for a merge request::
+
+ pipeline = mr.pipelines.create()