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
|
################################
Merge request approvals settings
################################
Merge request approvals can be defined at the group level, or the project level or at the merge request level.
Group approval rules
====================
References
----------
* v4 API:
+ :class:`gitlab.v4.objects.GroupApprovalRule`
+ :class:`gitlab.v4.objects.GroupApprovalRuleManager`
* GitLab API: https://docs.gitlab.com/api/merge_request_approvals
Examples
--------
List group-level MR approval rules::
group_approval_rules = group.approval_rules.list(get_all=True)
Change group-level MR approval rule::
g_approval_rule = group.approval_rules.get(123)
g_approval_rule.user_ids = [234]
g_approval_rule.save()
Create new group-level MR approval rule::
group.approval_rules.create({
"name": "my new approval rule",
"approvals_required": 2,
"rule_type": "regular",
"user_ids": [105],
"group_ids": [653, 654],
})
Project approval rules
======================
References
----------
* v4 API:
+ :class:`gitlab.v4.objects.ProjectApproval`
+ :class:`gitlab.v4.objects.ProjectApprovalManager`
+ :class:`gitlab.v4.objects.ProjectApprovalRule`
+ :class:`gitlab.v4.objects.ProjectApprovalRuleManager`
+ :attr:`gitlab.v4.objects.Project.approvals`
* GitLab API: https://docs.gitlab.com/api/merge_request_approvals
Examples
--------
List project-level MR approval rules::
p_mras = project.approvalrules.list(get_all=True)
Change project-level MR approval rule::
p_approvalrule.user_ids = [234]
p_approvalrule.save()
Delete project-level MR approval rule::
p_approvalrule.delete()
Get project-level MR approvals settings::
p_mras = project.approvals.get()
Change project-level MR approvals settings::
p_mras.approvals_before_merge = 2
p_mras.save()
Merge request approval rules
============================
References
----------
* v4 API:
+ :class:`gitlab.v4.objects.ProjectMergeRequestApproval`
+ :class:`gitlab.v4.objects.ProjectMergeRequestApprovalManager`
+ :attr:`gitlab.v4.objects.ProjectMergeRequest.approvals`
+ :class:`gitlab.v4.objects.ProjectMergeRequestApprovalRule`
+ :class:`gitlab.v4.objects.ProjectMergeRequestApprovalRuleManager`
+ :attr:`gitlab.v4.objects.ProjectMergeRequest.approval_rules`
+ :class:`gitlab.v4.objects.ProjectMergeRequestApprovalState`
+ :class:`gitlab.v4.objects.ProjectMergeRequestApprovalStateManager`
+ :attr:`gitlab.v4.objects.ProjectMergeRequest.approval_state`
* GitLab API: https://docs.gitlab.com/api/merge_request_approvals
Examples
--------
Get MR-level MR approvals settings::
p_mras = project.approvals.get()
mr_mras = mr.approvals.get()
Get MR-level approval state::
mr_approval_state = mr.approval_state.get()
Change MR-level MR approvals settings::
mr.approvals.set_approvers(approvals_required=1)
# or
mr_mras.approvals_required = 1
mr_mras.save()
Create a new MR-level approval rule or change an existing MR-level approval rule::
mr.approvals.set_approvers(approvals_required = 1, approver_ids=[105],
approver_group_ids=[653, 654],
approval_rule_name="my MR custom approval rule")
List MR-level MR approval rules::
mr.approval_rules.list(get_all=True)
Get a single MR approval rule::
approval_rule_id = 123
mr_approvalrule = mr.approval_rules.get(approval_rule_id)
Delete MR-level MR approval rule::
rules = mr.approval_rules.list(get_all=False)
rules[0].delete()
# or
mr.approval_rules.delete(approval_id)
Change MR-level MR approval rule::
mr_approvalrule.user_ids = [105]
mr_approvalrule.approvals_required = 2
mr_approvalrule.group_ids = [653, 654]
mr_approvalrule.save()
Create a MR-level MR approval rule::
mr.approval_rules.create({
"name": "my MR custom approval rule",
"approvals_required": 2,
"rule_type": "regular",
"user_ids": [105],
"group_ids": [653, 654],
})
|
