Merge request approvals settings

Merge request approvals can be defined at the project level or at the merge request level.

References

• v4 API:

  • gitlab.v4.objects.ProjectApproval

  • gitlab.v4.objects.ProjectApprovalManager

  • gitlab.v4.objects.ProjectApprovalRule

  • gitlab.v4.objects.ProjectApprovalRuleManager

  • gitlab.v4.objects.Project.approvals

  • gitlab.v4.objects.ProjectMergeRequestApproval

  • gitlab.v4.objects.ProjectMergeRequestApprovalManager

  • gitlab.v4.objects.ProjectMergeRequest.approvals

  • gitlab.v4.objects.ProjectMergeRequestApprovalRule

  • gitlab.v4.objects.ProjectMergeRequestApprovalRuleManager

  • gitlab.v4.objects.ProjectMergeRequest.approval_rules

• GitLab API: https://docs.gitlab.com/ee/api/merge_request_approvals.html

Examples

List project-level MR approval rules:

p_mras = project.approvalrules.list()

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 or MR-level MR approvals settings:

p_mras = project.approvals.get()

mr_mras = mr.approvals.get()

Change project-level or MR-level MR approvals settings:

p_mras.approvals_before_merge = 2
p_mras.save()

mr_mras.set_approvers(approvals_required = 1)

Change project-level MR allowed approvers:

project.approvals.set_approvers(approver_ids=[105],
                                 approver_group_ids=[653, 654])

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()

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],

})