diff options
Diffstat (limited to 'docs/gl_objects')
| -rw-r--r-- | docs/gl_objects/projects.rst | 34 |
1 files changed, 34 insertions, 0 deletions
diff --git a/docs/gl_objects/projects.rst b/docs/gl_objects/projects.rst index 0d117c5..ffaeb80 100644 --- a/docs/gl_objects/projects.rst +++ b/docs/gl_objects/projects.rst @@ -619,3 +619,37 @@ markdown to reference the uploaded file:: issue.notes.create({ "body": "See the [attached file]({})".format(uploaded_file["url"]) }) + +Project push rules +================== + +Reference +--------- + +* v4 API: + + + :class:`gitlab.v4.objects.ProjectPushRules` + + :class:`gitlab.v4.objects.ProjectPushRulesManager` + + :attr:`gitlab.v4.objects.Project.pushrules` + +* GitLab API: https://docs.gitlab.com/ee/api/projects.html#push-rules + +Examples +--------- + +Create project push rules (at least one rule is necessary):: + + project.pushrules.create({'deny_delete_tag': True}) + +Get project push rules (returns None is there are no push rules):: + + pr = project.pushrules.get() + +Edit project push rules:: + + pr.branch_name_regex = '^(master|develop|support-\d+|release-\d+\..+|hotfix-.+|feature-.+)$' + pr.save() + +Delete project push rules:: + + pr.delete() |