summaryrefslogtreecommitdiff
path: root/docs/gl_objects/protected_branches.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/gl_objects/protected_branches.rst')
-rw-r--r--docs/gl_objects/protected_branches.rst51
1 files changed, 0 insertions, 51 deletions
diff --git a/docs/gl_objects/protected_branches.rst b/docs/gl_objects/protected_branches.rst
deleted file mode 100644
index 3498aa5..0000000
--- a/docs/gl_objects/protected_branches.rst
+++ /dev/null
@@ -1,51 +0,0 @@
-##################
-Protected branches
-##################
-
-You can define a list of protected branch names on a repository. Names can use
-wildcards (``*``).
-
-References
-----------
-
-* v4 API:
-
- + :class:`gitlab.v4.objects.ProjectProtectedBranch`
- + :class:`gitlab.v4.objects.ProjectProtectedBranchManager`
- + :attr:`gitlab.v4.objects.Project.protectedbranches`
-
-* GitLab API: https://docs.gitlab.com/ce/api/protected_branches.html#protected-branches-api
-
-Examples
---------
-
-Get the list of protected branches for a project::
-
- p_branches = project.protectedbranches.list()
-
-Get a single protected branch::
-
- p_branch = project.protectedbranches.get('master')
-
-Create a protected branch::
-
- p_branch = project.protectedbranches.create({
- 'name': '*-stable',
- 'merge_access_level': gitlab.DEVELOPER_ACCESS,
- 'push_access_level': gitlab.MAINTAINER_ACCESS
- })
-
-Create a protected branch with more granular access control::
-
- p_branch = project.protectedbranches.create({
- 'name': '*-stable',
- 'allowed_to_push': [{"user_id": 99}, {"user_id": 98}],
- 'allowed_to_merge': [{"group_id": 653}],
- 'allowed_to_unprotect': [{"access_level": gitlab.MAINTAINER_ACCESS}]
- })
-
-Delete a protected branch::
-
- project.protectedbranches.delete('*-stable')
- # or
- p_branch.delete()