diff options
Diffstat (limited to 'docs/gl_objects')
| -rw-r--r-- | docs/gl_objects/groups.rst | 34 |
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() |