FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [View Raw Code]   [Original HTTPS Page]

python-gitlab/docs/gl_objects/protected_branches.rst at v8.1.0 · python-gitlab/python-gitlab · GitHub

Repository navigation

Latest commit

 

History

History
61 lines (43 loc) · 1.69 KB

File metadata and controls

61 lines (43 loc) · 1.69 KB

Protected branches

You can define a list of protected branch names on a repository or group. Names can use wildcards (*).

References

  • v4 API:
    • :class:`gitlab.v4.objects.ProjectProtectedBranch`
    • :class:`gitlab.v4.objects.ProjectProtectedBranchManager`
    • :attr:`gitlab.v4.objects.Project.protectedbranches`
    • :class:`gitlab.v4.objects.GroupProtectedBranch`
    • :class:`gitlab.v4.objects.GroupProtectedBranchManager`
    • :attr:`gitlab.v4.objects.Group.protectedbranches`
  • GitLab API: https://docs.gitlab.com/api/protected_branches#protected-branches-api

Examples

Get the list of protected branches for a project or group:

p_branches = project.protectedbranches.list()
p_branches = group.protectedbranches.list()

Get a single protected branch:

p_branch = project.protectedbranches.get('main')
p_branch = group.protectedbranches.get('main')

Update a protected branch:

p_branch.allow_force_push = True
p_branch.save()

Create a protected branch:

p_branch = project.protectedbranches.create({
    'name': '*-stable',
    'merge_access_level': gitlab.const.AccessLevel.DEVELOPER,
    'push_access_level': gitlab.const.AccessLevel.MAINTAINER
})

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.const.AccessLevel.MAINTAINER}]
})

Delete a protected branch:

project.protectedbranches.delete('*-stable')
# or
p_branch.delete()

Back | FazBrowse Home | New Git URL