blob: be93f12400a9b18f2805925ef08e4b3c47072e38 (
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
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
|
.. _merge_requests_examples:
##############
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.
Merge requests are linked to projects, but they can be listed globally or for
groups.
Group and global listing
========================
Reference
---------
* v4 API:
+ :class:`gitlab.v4.objects.GroupMergeRequest`
+ :class:`gitlab.v4.objects.GroupMergeRequestManager`
+ :attr:`gitlab.v4.objects.Group.mergerequests`
+ :class:`gitlab.v4.objects.MergeRequest`
+ :class:`gitlab.v4.objects.MergeRequestManager`
+ :attr:`gitlab.Gitlab.mergerequests`
* GitLab API: https://docs.gitlab.com/ce/api/merge_requests.html
Examples
--------
List the merge requests available on the GitLab server::
mrs = gl.mergerequests.list()
List the merge requests for a group::
group = gl.groups.get('mygroup')
mrs = group.mergerequests.list()
.. note::
It is not possible to edit or delete ``MergeRequest`` and
``GroupMergeRequest`` objects. You need to create a ``ProjectMergeRequest``
object to apply changes::
mr = group.mergerequests.list()[0]
project = gl.projects.get(mr.project_id, lazy=True)
editable_mr = project.mergerequests.get(mr.iid, lazy=True)
editable_mr.title = updated_title
editable_mr.save()
Project merge requests
======================
Reference
---------
* v4 API:
+ :class:`gitlab.v4.objects.ProjectMergeRequest`
+ :class:`gitlab.v4.objects.ProjectMergeRequestManager`
+ :attr:`gitlab.v4.objects.Project.mergerequests`
* GitLab API: https://docs.gitlab.com/ce/api/merge_requests.html
Examples
--------
List MRs for a project::
mrs = project.mergerequests.list()
You can filter and sort the returned list with the following parameters:
* ``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::
mrs = project.mergerequests.list(state='merged', order_by='updated_at')
Get a single MR::
mr = project.mergerequests.get(mr_id)
Create a MR::
mr = project.mergerequests.create({'source_branch': 'cool_feature',
'target_branch': 'master',
'title': 'merge cool feature',
'labels': ['label1', 'label2']})
Update a MR::
mr.description = 'New description'
mr.labels = ['foo', 'bar']
mr.save()
Change the state of a MR (close or reopen)::
mr.state_event = 'close' # or 'reopen'
mr.save()
Delete a MR::
project.mergerequests.delete(mr_id)
# or
mr.delete()
Accept a MR::
mr.merge()
Cancel a MR when the build succeeds::
mr.cancel_merge_when_pipeline_succeeds()
List commits of a MR::
commits = mr.commits()
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()
Subscribe to / unsubscribe from a MR::
mr.subscribe()
mr.unsubscribe()
Mark a MR as todo::
mr.todo()
List the diffs for a merge request::
diffs = mr.diffs.list()
Get a diff for a merge request::
diff = mr.diffs.get(diff_id)
Get time tracking stats::
merge request.time_stats()
On recent versions of Gitlab the time stats are also returned as a merge
request object attribute::
mr = project.mergerequests.get(id)
print(mr.attributes['time_stats'])
Set a time estimate for a merge request::
mr.time_estimate('3h30m')
Reset a time estimate for a merge request::
mr.reset_time_estimate()
Add spent time for a merge request::
mr.add_spent_time('3h30m')
Reset spent time for a merge request::
mr.reset_spent_time()
Get user agent detail for the issue (admin only)::
detail = issue.user_agent_detail()
Attempt to rebase an MR::
mr.rebase()
|
