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
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
|
.. _issues_examples:
######
Issues
######
Reported issues
===============
Reference
---------
* v4 API:
+ :class:`gitlab.v4.objects.Issue`
+ :class:`gitlab.v4.objects.IssueManager`
+ :attr:`gitlab.Gitlab.issues`
* GitLab API: https://docs.gitlab.com/ce/api/issues.html
Examples
--------
List the issues::
issues = gl.issues.list()
Use the ``state`` and ``label`` parameters to filter the results. Use the
``order_by`` and ``sort`` attributes to sort the results::
open_issues = gl.issues.list(state='opened')
closed_issues = gl.issues.list(state='closed')
tagged_issues = gl.issues.list(labels=['foo', 'bar'])
.. note::
It is not possible to edit or delete Issue objects. You need to create a
ProjectIssue object to perform changes::
issue = gl.issues.list()[0]
project = gl.projects.get(issue.project_id, lazy=True)
editable_issue = project.issues.get(issue.iid, lazy=True)
editable_issue.title = updated_title
editable_issue.save()
Group issues
============
Reference
---------
* v4 API:
+ :class:`gitlab.v4.objects.GroupIssue`
+ :class:`gitlab.v4.objects.GroupIssueManager`
+ :attr:`gitlab.v4.objects.Group.issues`
* GitLab API: https://docs.gitlab.com/ce/api/issues.html
Examples
--------
List the group issues::
issues = group.issues.list()
# Filter using the state, labels and milestone parameters
issues = group.issues.list(milestone='1.0', state='opened')
# Order using the order_by and sort parameters
issues = group.issues.list(order_by='created_at', sort='desc')
.. note::
It is not possible to edit or delete GroupIssue objects. You need to create
a ProjectIssue object to perform changes::
issue = group.issues.list()[0]
project = gl.projects.get(issue.project_id, lazy=True)
editable_issue = project.issues.get(issue.iid, lazy=True)
editable_issue.title = updated_title
editable_issue.save()
Project issues
==============
Reference
---------
* v4 API:
+ :class:`gitlab.v4.objects.ProjectIssue`
+ :class:`gitlab.v4.objects.ProjectIssueManager`
+ :attr:`gitlab.v4.objects.Project.issues`
* GitLab API: https://docs.gitlab.com/ce/api/issues.html
Examples
--------
List the project issues::
issues = project.issues.list()
# Filter using the state, labels and milestone parameters
issues = project.issues.list(milestone='1.0', state='opened')
# Order using the order_by and sort parameters
issues = project.issues.list(order_by='created_at', sort='desc')
Get a project issue::
issue = project.issues.get(issue_iid)
Create a new issue::
issue = project.issues.create({'title': 'I have a bug',
'description': 'Something useful here.'})
Update an issue::
issue.labels = ['foo', 'bar']
issue.save()
Close / reopen an issue::
# close an issue
issue.state_event = 'close'
issue.save()
# reopen it
issue.state_event = 'reopen'
issue.save()
Delete an issue::
project.issues.delete(issue_id)
# pr
issue.delete()
Subscribe / unsubscribe from an issue::
issue.subscribe()
issue.unsubscribe()
Move an issue to another project::
issue.move(other_project_id)
Make an issue as todo::
issue.todo()
Get time tracking stats::
issue.time_stats()
On recent versions of Gitlab the time stats are also returned as an issue
object attribute::
issue = project.issue.get(iid)
print(issue.attributes['time_stats'])
Set a time estimate for an issue::
issue.time_estimate('3h30m')
Reset a time estimate for an issue::
issue.reset_time_estimate()
Add spent time for an issue::
issue.add_spent_time('3h30m')
Reset spent time for an issue::
issue.reset_spent_time()
Get user agent detail for the issue (admin only)::
detail = issue.user_agent_detail()
Get the list of merge requests that will close an issue when merged::
mrs = issue.closed_by()
Get the merge requests related to an issue::
mrs = issue.related_merge_requests()
Get the list of participants::
users = issue.participants()
Issue links
===========
Reference
---------
* v4 API:
+ :class:`gitlab.v4.objects.ProjectIssueLink`
+ :class:`gitlab.v4.objects.ProjectIssueLinkManager`
+ :attr:`gitlab.v4.objects.ProjectIssue.links`
* GitLab API: https://docs.gitlab.com/ee/api/issue_links.html (EE feature)
Examples
--------
List the issues linked to ``i1``::
links = i1.links.list()
Link issue ``i1`` to issue ``i2``::
data = {
'target_project_id': i2.project_id,
'target_issue_iid': i2.iid
}
src_issue, dest_issue = i1.links.create(data)
.. note::
The ``create()`` method returns the source and destination ``ProjectIssue``
objects, not a ``ProjectIssueLink`` object.
Delete a link::
i1.links.delete(issue_link_id)
|
