如何在python-gitlab 3.13.0中实现分支保护与取消保护？

在python-gitlab 3.x版本中，原Branch对象的protect()和unprotect()方法已被移除，对应操作需要通过ProtectedBranch资源来实现，这是因为3.x版本的SDK结构和GitLab官方API做了对齐。

取消分支保护 #

需要先查询对应分支的受保护规则，再删除该规则：

import gitlab

# 假设已初始化gitlab客户端并获取到project对象
branch_name = "main"

try:
    # 获取分支的受保护规则
    protected_branch = project.protectedbranches.get(branch_name)
    # 删除规则即取消保护
    protected_branch.delete()
except gitlab.exceptions.GitlabGetError:
    # 分支未被保护，无需执行操作
    pass

添加分支保护 #

通过project.protectedbranches.create()方法创建保护规则，可配置推送、合并的权限级别：

import gitlab
from gitlab.const import AccessLevel

branch_name = "main"

# 配置保护规则：这里设置为仅维护者可推送和合并
protect_params = {
    "name": branch_name,
    "push_access_level": AccessLevel.MAINTAINER,  # 对应数值40，也可直接传数字
    "merge_access_level": AccessLevel.MAINTAINER,
    # 可选：指定允许推送/合并的用户ID列表，比如push_user_ids: [123, 456]
    # 可选：指定允许推送/合并的组ID列表，比如push_group_ids: [789]
}

# 创建保护规则
project.protectedbranches.create(protect_params)

关键说明 #

• 操作需要足够的权限：只有仓库的维护者及以上角色才能修改分支保护规则
• 若分支使用通配符（如feature/*），同样可以用上述方法创建/删除保护规则
• 捕获GitlabGetError是为了处理分支未被保护时的查询失败场景，避免程序报错

内容的提问来源于stack exchange，提问作者jarscs