From 449fc26ffa98ef5703d019154f37a4959816f607 Mon Sep 17 00:00:00 2001 From: "Peter B. Robinson" Date: Tue, 13 Oct 2020 14:25:30 -0700 Subject: docs: add Project Merge Request approval rule documentation --- docs/gl_objects/mr_approvals.rst | 34 +++++++++++++++++++++++++++++++--- 1 file changed, 31 insertions(+), 3 deletions(-) (limited to 'docs/gl_objects') 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) -- cgit v1.2.1 From aff9bc737d90e1a6e91ab8efa40a6756c7ce5cba Mon Sep 17 00:00:00 2001 From: "Peter B. Robinson" Date: Tue, 20 Oct 2020 09:45:43 -0700 Subject: docs: clean up grammar and formatting in documentation --- docs/gl_objects/mr_approvals.rst | 18 ++++++++---------- 1 file changed, 8 insertions(+), 10 deletions(-) (limited to 'docs/gl_objects') diff --git a/docs/gl_objects/mr_approvals.rst b/docs/gl_objects/mr_approvals.rst index 6e46ff8..ee0377d 100644 --- a/docs/gl_objects/mr_approvals.rst +++ b/docs/gl_objects/mr_approvals.rst @@ -58,7 +58,7 @@ 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 existing MR-level approval rule:: +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], @@ -76,12 +76,10 @@ Change MR-level MR approval rule:: 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) + mr.approval_rules.create({ + "name": "my MR custom approval rule", + "approvals_required": 2, + "rule_type": "regular", + "user_ids": [105], + "group_ids": [653, 654], + }) -- cgit v1.2.1