@@ -29,11 +29,9 @@ Reference
29
29
Examples
30
30
--------
31
31
32
- List MRs for a project:
32
+ List MRs for a project::
33
33
34
- .. literalinclude :: mrs.py
35
- :start-after: # list
36
- :end-before: # end list
34
+ mrs = project.mergerequests.list()
37
35
38
36
You can filter and sort the returned list with the following parameters:
39
37
@@ -43,80 +41,64 @@ You can filter and sort the returned list with the following parameters:
43
41
* ``order_by ``: sort by ``created_at `` or ``updated_at ``
44
42
* ``sort ``: sort order (``asc `` or ``desc ``)
45
43
46
- For example:
44
+ For example::
47
45
48
- .. literalinclude :: mrs.py
49
- :start-after: # list
50
- :end-before: # end list
46
+ mrs = project.mergerequests.list(state='merged', order_by='updated_at')
51
47
52
- Get a single MR:
48
+ Get a single MR::
53
49
54
- .. literalinclude :: mrs.py
55
- :start-after: # get
56
- :end-before: # end get
50
+ mr = project.mergerequests.get(mr_id)
57
51
58
- Create a MR:
52
+ Create a MR::
59
53
60
- .. literalinclude :: mrs.py
61
- :start-after: # create
62
- :end-before: # end create
54
+ mr = project.mergerequests.create({'source_branch': 'cool_feature',
55
+ 'target_branch': 'master',
56
+ 'title': 'merge cool feature',
57
+ 'labels': ['label1', 'label2']})
63
58
64
- Update a MR:
59
+ Update a MR::
65
60
66
- .. literalinclude :: mrs.py
67
- :start-after: # update
68
- :end-before: # end update
61
+ mr.description = 'New description'
62
+ mr.labels = ['foo', 'bar']
63
+ mr.save()
69
64
70
- Change the state of a MR (close or reopen):
65
+ Change the state of a MR (close or reopen)::
71
66
72
- .. literalinclude :: mrs.py
73
- :start-after: # state
74
- :end-before: # end state
67
+ mr.state_event = 'close' # or 'reopen'
68
+ mr.save()
75
69
76
- Delete a MR:
70
+ Delete a MR::
77
71
78
- .. literalinclude :: mrs.py
79
- :start-after: # delete
80
- :end-before: # end delete
72
+ project.mergerequests.delete(mr_id)
73
+ # or
74
+ mr. delete()
81
75
82
- Accept a MR:
76
+ Accept a MR::
83
77
84
- .. literalinclude :: mrs.py
85
- :start-after: # merge
86
- :end-before: # end merge
78
+ mr.merge()
87
79
88
- Cancel a MR when the build succeeds:
80
+ Cancel a MR when the build succeeds::
89
81
90
- .. literalinclude :: mrs.py
91
- :start-after: # cancel
92
- :end-before: # end cancel
82
+ mr.cancel_merge_when_build_succeeds() # v3
83
+ mr.cancel_merge_when_pipeline_succeeds() # v4
93
84
94
- List issues that will close on merge:
85
+ List issues that will close on merge::
95
86
96
- .. literalinclude :: mrs.py
97
- :start-after: # issues
98
- :end-before: # end issues
87
+ mr.closes_issues()
99
88
100
- Subscribe/ unsubscribe a MR:
89
+ Subscribe to / unsubscribe from a MR: :
101
90
102
- .. literalinclude :: mrs.py
103
- :start-after: # subscribe
104
- :end-before: # end subscribe
91
+ mr.subscribe()
92
+ mr.unsubscribe()
105
93
106
- Mark a MR as todo:
94
+ Mark a MR as todo::
107
95
108
- .. literalinclude :: mrs.py
109
- :start-after: # todo
110
- :end-before: # end todo
96
+ mr.todo()
111
97
112
- List the diffs for a merge request:
98
+ List the diffs for a merge request::
113
99
114
- .. literalinclude :: mrs.py
115
- :start-after: # diff list
116
- :end-before: # end diff list
100
+ diffs = mr.diffs.list()
117
101
118
- Get a diff for a merge request:
102
+ Get a diff for a merge request::
119
103
120
- .. literalinclude :: mrs.py
121
- :start-after: # diff get
122
- :end-before: # end diff get
104
+ diff = mr.diffs.get(diff_id)
0 commit comments