diff options
author | Peter B. Robinson <robinson96@llnl.gov> | 2020-10-13 14:25:30 -0700 |
---|---|---|
committer | Peter B. Robinson <robinson96@llnl.gov> | 2020-10-13 14:25:30 -0700 |
commit | 449fc26ffa98ef5703d019154f37a4959816f607 (patch) | |
tree | a762d9b7c935938333822b957f2c4c8f8915be08 | |
parent | c6fbf399ec5cbc92f995a5d61342f295be68bd79 (diff) | |
download | gitlab-449fc26ffa98ef5703d019154f37a4959816f607.tar.gz |
docs: add Project Merge Request approval rule documentation
-rw-r--r-- | docs/gl_objects/mr_approvals.rst | 34 |
1 files changed, 31 insertions, 3 deletions
diff --git a/docs/gl_objects/mr_approvals.rst b/docs/gl_objects/mr_approvals.rst index 253b68d..6e46ff8 100644 --- a/docs/gl_objects/mr_approvals.rst +++ b/docs/gl_objects/mr_approvals.rst @@ -18,6 +18,9 @@ References + :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` * GitLab API: https://docs.gitlab.com/ee/api/merge_request_approvals.html @@ -50,10 +53,35 @@ Change project-level or MR-level MR approvals settings:: mr_mras.set_approvers(approvals_required = 1) -Change project-level or MR-level MR allowed approvers:: +Change project-level MR allowed approvers:: project.approvals.set_approvers(approver_ids=[105], - approver_group_ids=[653, 654]) + approver_group_ids=[653, 654]) + +Create a new MR-level approval rule or Change existing MR-level approval rule:: mr.approvals.set_approvers(approvals_required = 1, approver_ids=[105], - approver_group_ids=[653, 654]) + 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:: + + data = { + "name": "my MR custom approval rule", + "approvals_required": 2, + "rule_type": "regular", + "user_ids": [105], + "group_ids": [653, 654], + } + mr.approval_rules.create(data=data) |