受保护的分支

在极狐GitLab 中，权限基本上是围绕对仓库和分支具有读或写权限的想法定义的。为了对某些分支施加进一步的限制，它们可以受保护。

默认情况下，您的仓库的默认分支受保护。

谁可以修改受保护的分支

当分支受到保护时，默认会对该分支实施以下限制。

操作 谁可以操作
保护分支 至少具有维护者角色。
推送到分支 任何具有已允许权限的用户。 (1)
强制推送到分支 没有人。
删除分支 没有人。 (2)
  1. 具有开发人员角色的用户可以在群组中创建项目，但可能不允许首次推送到默认分支。
  2. 没有人可以使用 Git 命令删除受保护的分支，但是，至少具有维护者角色的用户可以从 UI 或 API 中删除受保护的分支。

当一个分支匹配多个规则时

当一个分支匹配多个规则时，最宽松的规则决定分支的保护级别。例如，参考以下规则，其中包括通配符：

分支名称样式 允许推送 允许推送和合并
v1.x 维护者 维护者
v1.* 维护者和开发者 维护者
v* 没有人 没有人

名为 v1.x 的分支匹配所有三个分支名称样式：v1.x、v1.* 和 v*。由于最宽松的规则决定分支的保护级别，因此分支 v1.x 的最终权限为：

  • 允许合并：在这三个设置中，维护者和开发者是最宽松的。即使该分支也匹配了 v1.x 和 v*（它们都有更严格的权限），具有开发者角色的用户可以合并内容到分支中。
  • 允许推送和合并：在这三个设置中，维护者是最宽松的。即使与 v* 匹配的分支被设置为无，匹配 v1.x 或 v1.* 的分支会获得更宽松的维护者权限。

为确保规则可以控制分支的行为，匹配的所有其他样式必须使用更少或同样宽松的规则。

如果要确保不允许任何人推送到分支 v1.x，则每个匹配 v1.x 的样式都必须将允许推送和合并设置为无，如下所示：

分支名称样式 允许推送 允许推送和合并
v1.x 维护者 没有人
v1.* 维护者和开发者 没有人
v* 没有人 没有人

设置默认分支保护级别

管理员可以在管理中心设置默认分支保护级别。

配置受保护的分支

为一个群组中的所有项目或仅为一个项目配置受保护的分支。

对于群组中的所有项目

引入于 15.9 版本，默认禁用。

群组所有者可以为群组创建受保护的分支。这些设置由群组中的所有项目继承，不能被项目设置覆盖。

在私有化部署版上，此功能默认不可用。要使其可用，需要管理员启用功能标志 group_protected_branches。在 SaaS 上，此功能不可用。

先决条件：

  • 您必须在群组中具有所有者角色。

要保护群组中所有项目的分支：

  1. 在左侧边栏中选择 搜索或转到 并找到您的群组。
  2. 在左侧边栏中，选择 设置 > 仓库。
  3. 展开 受保护的分支。
  4. 在 分支 文本框中，键入分支名称或通配符。
  5. 从 允许合并 列表中，选择可以合并到该分支的角色。
  6. 从 允许推送和合并 列表中，选择一个可以推送到该分支的角色。
  7. 选择 保护。

受保护分支被添加到受保护分支列表中。

对于项目

先决条件：

  • 您必须至少具有维护者角色。
  • 当授予用户群组 允许合并 或 允许推送和合并 受保护分支的权限时，必须将该用户群组添加到项目中。

保护分支：

  1. 在左侧边栏中，选择 搜索或转到 并找到您的项目。
  2. 在左侧边栏中，选择 设置 > 仓库。
  3. 展开 受保护的分支。
  4. 从 分支 下拉列表中，选择您要保护的分支。
  5. 从 允许合并 列表中，选择可以合并到该分支的角色或群组。在专业版中，您还可以添加用户。
  6. 从 允许推送和合并 列表中，选择可以推送到该分支的角色、群组或用户。在专业版中，您还可以添加用户。
  7. 选择 保护。

受保护分支显示在受保护分支列表中。

使用通配符配置多个受保护分支

如果特定规则和通配符规则都适用于同一分支，则最宽松的规则控制分支的行为方式。要使合并控制正常工作，请将 允许推送和合并 设置为比 允许合并 具有更广泛的用户集。

先决条件：

  • 您必须至少具有维护者角色。

同时保护多个分支：

  1. 转到您的项目并选择 设置 > 仓库。
  2. 展开 受保护的分支。

  3. 从 分支 下拉菜单中，输入分支名称和通配符。 例如：

    通配符保护分支 匹配分支
    *-stable production-stable, staging-stable
    production/* production/app-server, production/load-balancer
    *gitlab* gitlab, gitlab/staging, master/gitlab/production
  4. 从 允许合并 列表中，选择可以合并到此分支的角色或群组。在专业版中，您还可以添加用户。
  5. 从 允许推送和合并 列表中，选择可以推送到此分支的角色、群组或用户。在专业版中，您还可以添加用户。
  6. 选择 保护。

受保护分支显示在受保护分支列表中。

创建受保护的分支

具有开发人员或更高角色的用户可以创建受保护的分支。

先决条件：

  • 允许推送和合并 设置为 没有人
  • 允许合并 设置为 开发者。

您只能使用 UI 或 API 创建受保护的分支。 这可以防止您从命令行或 Git 客户端应用程序意外创建分支。

要通过用户界面创建新分支：

  1. 转到 代码 > 分支。
  2. 选择 新建分支。
  3. 填写分支名称并选择现有分支、标记或提交，作为新分支的基础。只接受现有的受保护分支和已经在受保护分支中的提交。

要求每个人提交受保护分支的合并请求

您可以强制每个人提交合并请求，而不是让他们直接检入受保护的分支。与 GitLab 工作流 等类似的工作流兼容。

  1. 转到您的项目并选择 设置 > 仓库。
  2. 展开 受保护的分支。
  3. 从 分支 下拉菜单中，选择要保护的分支。
  4. 从 允许合并 列表中，选择 开发人员 + 维护人员。
  5. 从 允许推送和合并 列表中，选择 没有人。
  6. 选择 保护。

允许所有人直接推送到受保护的分支

您可以允许具有写访问权限的每个人推送到受保护的分支。

  1. 转到您的项目并选择 设置 > 仓库。
  2. 展开 受保护的分支。
  3. 从 分支 下拉菜单中，选择要保护的分支。
  4. 从 允许推送和合并 列表中，选择 开发人员 + 维护人员。
  5. 选择 保护。

允许部署密钥推送到受保护的分支

您可以允许部署密钥的所有者推送到受保护的分支。 即使用户不是相关项目的成员，部署密钥也有效。但是，部署密钥的所有者必须至少具有对项目的读取权限。

先决条件：

  • 部署密钥必须为您的项目启用。
  • 部署密钥必须对您的项目仓库具有写访问权限。

要允许部署密钥推送到受保护的分支：

  1. 转到您的项目并选择 设置 > 仓库。
  2. 展开 受保护的分支。
  3. 从 分支 下拉菜单中，选择要保护的分支。
  4. 从 允许推送和合并 列表中，选择部署密钥。
  5. 选择 保护。

部署密钥在 允许合并 下拉列表中不可用。

允许强制推送受保护的分支

  • 引入于 13.10 版本，在功能标志 allow_force_push_to_protected_branches 后默认禁用。
  • 功能标志移除于 14.0 版本。
caution 您可能无法使用此功能。查看上面的版本历史注释以了解详细信息。

您可以允许强制推送到受保护的分支。

要保护新分支并启用强制推送：

  1. 转到您的项目并选择 设置 > 仓库。
  2. 展开 受保护的分支。
  3. 从 分支 下拉菜单中，选择要保护的分支。
  4. 从 允许推送和合并 和 允许合并 列表中，选择您想要的设置。
  5. 要允许所有具有推送访问权限的用户强制推送，请打开 允许强制推送 开关。
  6. 要拒绝更改 CODEOWNERS 文件中列出的文件的代码推送，请打开 需要代码所有者的批准 开关。
  7. 选择 保护。

要在已经受保护的分支上启用强制推送：

  1. 转到您的项目并选择 设置 > 仓库。
  2. 展开 受保护的分支。
  3. 在受保护分支列表中，打开分支旁边的 允许强制推送 开关。

启用后，可以推送到此分支的成员也可以强制推送。

要求受保护分支的代码所有者批准

对于受保护的分支，您可以要求至少获得代码所有者的一项批准。

要保护新分支并启用代码所有者的批准：

  1. 转到您的项目并选择 设置 > 仓库。
  2. 展开 受保护的分支。
  3. 从 分支 下拉菜单中，选择要保护的分支。
  4. 从 允许推送和合并 和 允许合并 列表中，选择您想要的设置。
  5. 打开 需要代码所有者的批准 开关。
  6. 选择 保护。

要在已受保护的分支上启用代码所有者的批准：

  1. 转到您的项目并选择 设置 > 仓库。
  2. 展开 受保护的分支。
  3. 在受保护分支列表中，打开分支旁边的 需要代码所有者批准 开关。

启用后，这些分支的所有合并请求都需要每个匹配规则的代码所有者批准，然后才能合并。 此外，如果匹配规则，则拒绝直接推送到受保护分支。

任何未在 CODEOWNERS 文件中指定的用户都不能推送指定文件或路径的更改，除非他们被特别允许。 您不必限制开发人员直接推送到受保护的分支。相反，您可以限制推送到某些需要代码所有者审核的文件。

在专业版 13.5 及更高版本中，允许推送到受保护分支的用户和群组不需要合并请求来合并其功能分支。 因此，他们可以跳过合并请求批准规则，包括代码所有者。

在受保护的分支上运行流水线

合并或推送到受保护分支的权限定义了用户是否可以运行 CI/CD 流水线并对作业执行操作。

删除受保护的分支

具有维护者角色及更高级别的用户可以使用 GitLab Web 界面手动删除受保护的分支：

  1. 转到 代码 > 分支。
  2. 在要删除的分支旁边，选择 删除 按钮 ( )。
  3. 在确认对话框中，输入分支名称。
  4. 选择 是，删除受保护的分支。

只能从 UI 或 API 使用极狐GitLab 删除受保护的分支。 这可以防止通过本地 Git 命令或第三方 Git 客户端意外删除分支。