summaryrefslogtreecommitdiff
path: root/docs/gl_objects
diff options
context:
space:
mode:
authorO'Keefe, Gerard (Gerry) <gokeefe@atb.com>2022-07-04 10:54:51 -0700
committerJohn L. Villalovos <john@sodarock.com>2022-07-04 10:54:51 -0700
commitb5cdc097005c8a48a16e793a69c343198b14e035 (patch)
tree972c6a46ccb6effee32a96453b90beb2138ef545 /docs/gl_objects
parent3df404c8165c36486bbcdf03816bd0b3173d9de8 (diff)
downloadgitlab-b5cdc097005c8a48a16e793a69c343198b14e035.tar.gz
feat: add support for group push rules
Add the GroupPushRules and GroupPushRulesManager classes. Closes: #1259
Diffstat (limited to 'docs/gl_objects')
-rw-r--r--docs/gl_objects/groups.rst34
1 files changed, 34 insertions, 0 deletions
diff --git a/docs/gl_objects/groups.rst b/docs/gl_objects/groups.rst
index c4d9fdc..b9b865a 100644
--- a/docs/gl_objects/groups.rst
+++ b/docs/gl_objects/groups.rst
@@ -376,3 +376,37 @@ Delete a group hook::
group.hooks.delete(hook_id)
# or
hook.delete()
+
+Group push rules
+==================
+
+Reference
+---------
+
+* v4 API:
+
+ + :class:`gitlab.v4.objects.GroupPushRules`
+ + :class:`gitlab.v4.objects.GroupPushRulesManager`
+ + :attr:`gitlab.v4.objects.Group.pushrules`
+
+* GitLab API: https://docs.gitlab.com/ee/api/groups.html#push-rules
+
+Examples
+---------
+
+Create group push rules (at least one rule is necessary)::
+
+ group.pushrules.create({'deny_delete_tag': True})
+
+Get group push rules (returns None is there are no push rules)::
+
+ pr = group.pushrules.get()
+
+Edit group push rules::
+
+ pr.branch_name_regex = '^(master|develop|support-\d+|release-\d+\..+|hotfix-.+|feature-.+)$'
+ pr.save()
+
+Delete group push rules::
+
+ pr.delete()