blob: 04d413c1fcf9c82c4961a342e37ebb5d799b07b1 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
|
##############
Merge requests
##############
You can use merge requests to notify a project that a branch is ready for
merging. The owner of the target projet can accept the merge request.
The v3 API uses the ``id`` attribute to identify a merge request, the v4 API
uses the ``iid`` attribute.
Reference
---------
* v4 API:
+ :class:`gitlab.v4.objects.ProjectMergeRequest`
+ :class:`gitlab.v4.objects.ProjectMergeRequestManager`
+ :attr:`gitlab.v4.objects.Project.mergerequests`
* v3 API:
+ :class:`gitlab.v3.objects.ProjectMergeRequest`
+ :class:`gitlab.v3.objects.ProjectMergeRequestManager`
+ :attr:`gitlab.v3.objects.Project.mergerequests`
+ :attr:`gitlab.Gitlab.project_mergerequests`
* GitLab API: https://docs.gitlab.com/ce/api/merge_requests.html
Examples
--------
List MRs for a project:
.. literalinclude:: mrs.py
:start-after: # list
:end-before: # end list
You can filter and sort the returned list with the following parameters:
* ``iid``: iid (unique ID for the project) of the MR (v3 API)
* ``state``: state of the MR. It can be one of ``all``, ``merged``, ``opened``
or ``closed``
* ``order_by``: sort by ``created_at`` or ``updated_at``
* ``sort``: sort order (``asc`` or ``desc``)
For example:
.. literalinclude:: mrs.py
:start-after: # list
:end-before: # end list
Get a single MR:
.. literalinclude:: mrs.py
:start-after: # get
:end-before: # end get
Create a MR:
.. literalinclude:: mrs.py
:start-after: # create
:end-before: # end create
Update a MR:
.. literalinclude:: mrs.py
:start-after: # update
:end-before: # end update
Change the state of a MR (close or reopen):
.. literalinclude:: mrs.py
:start-after: # state
:end-before: # end state
Delete a MR:
.. literalinclude:: mrs.py
:start-after: # delete
:end-before: # end delete
Accept a MR:
.. literalinclude:: mrs.py
:start-after: # merge
:end-before: # end merge
Cancel a MR when the build succeeds:
.. literalinclude:: mrs.py
:start-after: # cancel
:end-before: # end cancel
List issues that will close on merge:
.. literalinclude:: mrs.py
:start-after: # issues
:end-before: # end issues
Subscribe/unsubscribe a MR:
.. literalinclude:: mrs.py
:start-after: # subscribe
:end-before: # end subscribe
Mark a MR as todo:
.. literalinclude:: mrs.py
:start-after: # todo
:end-before: # end todo
List the diffs for a merge request:
.. literalinclude:: mrs.py
:start-after: # diff list
:end-before: # end diff list
Get a diff for a merge request:
.. literalinclude:: mrs.py
:start-after: # diff get
:end-before: # end diff get
|
