Skip to content
代码片段 群组 项目
未验证 提交 f5850ab4 编辑于 作者: Brendan Lynch's avatar Brendan Lynch 提交者： GitLab
浏览文件

Apply 1 suggestion(s) to 1 file(s) 


Co-authored-by: default avatarPaulina Sedlak-Jakubowska <psedlak-jakubowska@gitlab.com>
上级 e791417d
No related branches found
No related tags found
无相关合并请求
隐藏空白变更内容
行内 左右并排
doc/user/project/merge_requests/status_checks.md
+ 1
− 27
浏览文件 @ f5850ab4
......@@ -74,10 +74,6 @@ using the API. You don't need to wait for a merge request webhook payload to be
## View status check services
You can see a list of status check services added to a project from the **Merge requests** settings and the **Branch rules** settings.
### From merge request settings
To view a list of status check services added to a project from the merge request settings:
1. On the left sidebar, select **Search or go to** and find your project.
......@@ -87,29 +83,7 @@ To view a list of status check services added to a project from the merge reques
![Status checks list](img/status_checks_list_view_v14_0.png)
### From branch rules settings
> - [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/12522) in GitLab 17.4 [with a flag](../../../administration/feature_flags.md) named `edit_branch_rules`. Disabled by default.
> - [Enabled on GitLab.com](https://gitlab.com/gitlab-org/gitlab/-/issues/454501) in GitLab 17.4.
To view a list of status check services when you [create](../repository/branches/index.md#create-a-branch-rule) or
[edit](../repository/branches/index.md#edit-a-branch-rule) a branch rule:
1. Go to your project repository settings:
1. On the left sidebar, select **Search or go to** and find your project.
1. Select **Settings > Repository**.
1. Expand **Branch rules**.
1. Choose one of the following options:
- To create a branch rule, select **Add branch rule**.
- To edit a branch rule, select **View details**.
1. At bottom of the **Branch rule details** page, view the list of **Status checks**.
The list displays the service name and the API URL.
![Branch rules status checks](img/branch_rule_status_check.png)
You can also view a list of status check services from the [Branch rules](../repository/branches/branch_rules.md#add-a-status-check-service) settings.
## Add or update a status check service
......
doc/user/project/repository/branches/branch_rules.md 0 → 100644
+ 235
− 0
浏览文件 @ f5850ab4
---
stage: Create
group: Source Code
info: "To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments"
description: "Understand how to name, manage, and protect Git branches."
---
# Branch rules
DETAILS:
**Tier:** Free, Premium, Ultimate
**Offering:** GitLab.com, Self-managed, GitLab Dedicated
GitLab provides multiple methods to protect individual branches. These methods
ensure your branches receive oversight and quality checks from their creation to their deletion:
- Apply enhanced security and protection to your project's [default branch](default.md).
- Configure [protected branches](../../repository/branches/protected.md) to:
- Limit who can push and merge to a branch.
- Manage if users can force push to the branch.
- Manage if changes to files listed in the `CODEOWNERS` file can be pushed directly to the branch.
- Configure [approval rules](../../merge_requests/approvals/rules.md#approvals-for-protected-branches) to manage review requirements and implement [security-related approvals](../../merge_requests/approvals/rules.md#security-approvals).
- Integrate with third-party [status checks](../../merge_requests/status_checks.md)
to ensure the contents of your branch meets your defined quality standards.
You can manage your branches:
- With the GitLab user interface.
- With Git on the command line.
- With the [Branches API](../../../../api/branches.md).
## View branch rules
> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/88279) in GitLab 15.1 with a flag named `branch_rules`. Disabled by default.
> - [Enabled on self-managed](https://gitlab.com/gitlab-org/gitlab/-/issues/363170) in GitLab 15.11.
> - [Generally available](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/123368) in GitLab 16.1. Feature flag `branch_rules` removed.
The **Branch rules overview** page shows all branches with any configured protections,
and their protection methods:
![Example of a branch with configured protections](img/view_branch_protections_v15_10.png)
Prerequisites:
- You must have at least the Maintainer role for the project.
To view the **Branch rules overview** list:
1. On the left sidebar, select **Search or go to** and find your project.
1. Select **Settings > Repository**.
1. Expand **Branch rules** to view all branches with protections.
### View branch rule details
To view branch rules and protections for a single branch:
1. On the left sidebar, select **Search or go to** and find your project.
1. Select **Settings > Repository**.
1. Expand **Branch rules** to view all branches with protections.
1. Identify the branch you want and select **View details**.
## Create a branch rule
> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/88279) in GitLab 16.8 with a flag named `add_branch_rules`. Disabled by default.
> - Feature flag `add_branch_rules` [renamed](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/88279) to `edit_branch_rules` in GitLab 16.11. Disabled by default.
> - **All branches** and **All protected branches** options [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/388129) in GitLab 17.0.
> - [Enabled on GitLab.com](https://gitlab.com/gitlab-org/gitlab/-/issues/454501) in GitLab 17.4.
FLAG:
The availability of this feature is controlled by a feature flag.
For more information, see the history.
Prerequisites:
- You must have at least the Maintainer role for the project.
To create a branch rule:
1. On the left sidebar, select **Search or go to** and find your project.
1. Select **Settings > Repository**.
1. Expand **Branch rules**.
1. Select **Add branch rule**.
1. Choose one of the following options:
- To enter a specific branch name or pattern:
1. Select **Branch name or pattern**.
1. From the **Create branch rule** dropdown list, select a branch name or create a wildcard by typing `*`.
- To protect all branches in the project:
1. Select **All branches**.
1. On the rule's details page, under **Merge request approvals**, enter the required number of approvals for the rule.
- To protect all branches in the project that are already specified as protected:
1. Select **All protected branches**.
1. On the rule's details page, under **Merge request approvals**, enter the required number of approvals for the rule.
### Add a branch rule protection
NOTE:
Not available for `all branches`.
To add protections to a new branch:
1. On the left sidebar, select **Search or go to** and find your project.
1. Select **Settings > Repository**.
1. Expand **Branch rules**.
1. Select **Add branch rule**.
1. Select one of **All protected branches** or **Branch name or pattern**.
1. Select **Create protected branch**.
### Add an approval rule
DETAILS:
**Tier:** Premium, Ultimate
**Offering:** GitLab.com, Self-managed, GitLab Dedicated
NOTE:
Not available for `all branches`.
Prerequisites:
- You must have at least the Maintainer role for the project.
To add a merge request approval rule:
1. From the [branch rule details](#view-branch-rule-details) page, go to the **Merge request approvals** section.
1. In the **Approval rules** section, select **Add approval rule**.
1. On the right sidebar, complete the fields:
- Enter a **Rule name**.
- In **Required number of approvals**, enter a value (`0`-`100`).
A value of `0` makes [the rule optional](../../merge_requests/approvals/rules.md#configure-optional-approval-rules), and any number greater than `0` creates a required rule.
The maximum number of required approvals is `100`.
- Select users or groups that are
[eligible to approve](../../merge_requests/approvals/rules.md#eligible-approvers).
GitLab suggests approvers based on previous authors of the files changed by the merge request.
1. Select **Save changes**.
For additional information, see [Approval rules](../../merge_requests/approvals/rules.md#approvals-for-protected-branches).
### Add a status check service
DETAILS:
**Tier:** Ultimate
**Offering:** GitLab.com, Self-managed, GitLab Dedicated
> - [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/12522) in GitLab 17.4 [with a flag](../../../../administration/feature_flags.md) named `edit_branch_rules`. Disabled by default.
> - [Enabled on GitLab.com](https://gitlab.com/gitlab-org/gitlab/-/issues/454501) in GitLab 17.4.
NOTE:
Not available for `all protected branches`.
To add a status check service:
1. From the [branch rule details](#view-branch-rule-details) page, go to the **Status checks** section.
1. Select **Add status check**.
1. Enter the **Service name**.
1. In the **API to check** field, enter the URL.
You should use a HTTPS URL to protect your merge request data in transit.
![Branch rules status checks](img/branch_rule_status_check.png)
For more information, see [External status checks](../../merge_requests/status_checks.md).
## Edit a branch rule target
> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/88279) in GitLab 16.8 with a flag named `add_branch_rules`. Disabled by default.
> - Feature flag `add_branch_rules` [renamed](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/88279) to `edit_branch_rules` in GitLab 16.11. Disabled by default.
> - [Enabled on GitLab.com](https://gitlab.com/gitlab-org/gitlab/-/issues/454501) in GitLab 17.4.
FLAG:
The availability of this feature is controlled by a feature flag.
For more information, see the history.
Prerequisites:
- You must have at least the Maintainer role for the project.
To edit a branch rule target:
1. On the left sidebar, select **Search or go to** and find your project.
1. Select **Settings > Repository**.
1. Expand **Branch rules** to view all branches with protections.
1. Identify the branch you want and select **View details**.
1. In the **Rule target** section, select **Edit**.
1. Edit the information as needed.
1. Select **Update**.
### Edit a branch rule protection
NOTE:
Not available for `all branches`.
To edit branch rule protections:
1. On the left sidebar, select **Search or go to** and find your project.
1. Select **Settings > Repository**.
1. Expand **Branch rules** to view all branches with protections.
1. Identify the branch you want and select **View details**.
1. From the **Protect branch** section, choose one of the following options:
- From **Allowed to merge**, select **Edit**.
1. Select the roles that can merge into this branch.
1. Select **Save changes**.
- From **Allowed to push and merge**, select **Edit**.
1. Select the roles that can merge into this branch.
1. If desired, search to add **Deploy keys**.
1. Select **Save changes**.
NOTE:
In GitLab Premium and Ultimate, you can also add groups or individual users
to **Allowed to merge** and **Allowed to push and merge**.
For additional information about branch protection controls, see [Protected branches](../../repository/branches/protected.md).
## Delete a branch rule
> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/88279) in GitLab 16.8 with a flag named `add_branch_rules`. Disabled by default.
> - Feature flag `add_branch_rules` [renamed](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/88279) to `edit_branch_rules` in GitLab 16.11. Disabled by default.
> - [Enabled on GitLab.com](https://gitlab.com/gitlab-org/gitlab/-/issues/454501) in GitLab 17.4.
FLAG:
The availability of this feature is controlled by a feature flag.
For more information, see the history.
Prerequisites:
- You must have at least the Maintainer role for the project.
To delete a branch rule:
1. On the left sidebar, select **Search or go to** and find your project.
1. Select **Settings > Repository**.
1. Expand **Branch rules**.
1. Next to a rule you want to delete, select **View details**.
1. In the upper-right corner, select **Delete rule**.
1. On the confirmation dialog, select **Delete branch rule**.
doc/user/project/repository/branches/index.md
+ 2
− 127
浏览文件 @ f5850ab4
......@@ -55,7 +55,7 @@ On this page, you can:
Branches with merge requests that do not point to the default branch display the **{merge-request}** **New** merge request button.
- [View branch rules](#view-branch-rules).
- [View branch rules](branch_rules.md#view-branch-rules).
- See latest pipeline status on the branch.
## Create a branch
......@@ -195,132 +195,7 @@ GitLab uses the issue number to import data into the merge request:
## Manage and protect branches
GitLab provides multiple methods to protect individual branches. These methods
ensure your branches receive oversight and quality checks from their creation to their deletion:
- Apply enhanced security and protection to your project's [default branch](default.md).
- Configure [protected branches](../../repository/branches/protected.md) to:
- Limit who can push and merge to a branch.
- Manage if users can force push to the branch.
- Manage if changes to files listed in the `CODEOWNERS` file can be pushed directly to the branch.
- Configure [approval rules](../../merge_requests/approvals/rules.md#approvals-for-protected-branches) to manage review requirements and implement [security-related approvals](../../merge_requests/approvals/rules.md#security-approvals).
- Integrate with third-party [status checks](../../merge_requests/status_checks.md)
to ensure the contents of your branch meets your defined quality standards.
You can manage your branches:
- With the GitLab user interface.
- With Git on the command line.
- With the [Branches API](../../../../api/branches.md).
### View branch rules
> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/88279) in GitLab 15.1 with a flag named `branch_rules`. Disabled by default.
> - [Enabled on GitLab.com](https://gitlab.com/gitlab-org/gitlab/-/issues/363170) in GitLab 15.10.
> - [Enabled on self-managed](https://gitlab.com/gitlab-org/gitlab/-/issues/363170) in GitLab 15.11.
> - [Generally available](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/123368) in GitLab 16.1. Feature flag `branch_rules` removed.
The **Branch rules overview** page shows all branches with any configured protections,
and their protection methods:
![Example of a branch with configured protections](img/view_branch_protections_v15_10.png)
Prerequisites:
- You must have at least the Maintainer role for the project.
To view the **Branch rules overview** list:
1. On the left sidebar, select **Search or go to** and find your project.
1. Select **Settings > Repository**.
1. Expand **Branch rules** to view all branches with protections.
- To add protections to a new branch:
1. Select **Add branch rule**.
1. Select one of **All branches**, **All protected branches**, or **Branch name or pattern**.
1. Select **Create protected branch**.
- To view more information about protections on an existing branch:
1. Identify the branch you want more information about.
1. Select **View details** to see information about its:
- [Branch protections](../../repository/branches/protected.md): Not available for `all branches`.
- [Approval rules](../../merge_requests/approvals/rules.md#approvals-for-protected-branches): Not available for `all branches`.
- [Status checks](../../merge_requests/status_checks.md): Not available for `all protected branches`.
### Create a branch rule
> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/88279) in GitLab 16.8 with a flag named `add_branch_rules`. Disabled by default.
> - Feature flag `add_branch_rules` [renamed](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/88279) to `edit_branch_rules` in GitLab 16.11. Disabled by default.
> - **All branches** and **All protected branches** options [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/388129) in GitLab 17.0.
> - [Enabled on GitLab.com](https://gitlab.com/gitlab-org/gitlab/-/issues/454501) in GitLab 17.4.
FLAG:
The availability of this feature is controlled by a feature flag.
For more information, see the history.
Prerequisites:
- You must have at least the Maintainer role for the project.
To create a branch rule:
1. On the left sidebar, select **Search or go to** and find your project.
1. Select **Settings > Repository**.
1. Expand **Branch rules**.
1. Then:
- To enter a specific branch name or pattern:
1. In the **Add branch rule** dropdown list, select **Branch name or pattern**.
1. On the dialog, from the **Create branch rule** dropdown list, select a branch name or create a wildcard by typing `*`.
- To protect all branches in the project:
1. In the **Add branch rule** dropdown list, select **All branches**.
1. On the rule's details page, under **Merge request approvals**, enter the required number of approvals for the rule.
- To protect all branches in the project that are already specified as protected:
1. In the **Add branch rule** dropdown list, select **All protected branches**.
1. On the rule's details page, under **Merge request approvals**, enter the required number of approvals for the rule.
### Edit a branch rule
> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/88279) in GitLab 16.8 with a flag named `add_branch_rules`. Disabled by default.
> - Feature flag `add_branch_rules` [renamed](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/88279) to `edit_branch_rules` in GitLab 16.11. Disabled by default.
> - [Enabled on GitLab.com](https://gitlab.com/gitlab-org/gitlab/-/issues/454501) in GitLab 17.4.
FLAG:
On self-managed GitLab, by default this feature is not available. To make it available per project or for your entire instance, an administrator can [enable the feature flag](../../../../administration/feature_flags.md) named `edit_branch_rules`.
The availability of this feature is controlled by a feature flag. For more information, see the history.
Prerequisites:
- You must have at least the Maintainer role for the project.
To edit a branch rule:
1. On the left sidebar, select **Search or go to** and find your project.
1. Select **Settings > Repository**.
1. Expand **Branch rules**.
1. Next to a rule you want to edit, select **View details**.
1. In the upper-right corner, select **Edit**.
1. Edit the information as needed.
1. Select **Update**.
### Delete a branch rule
> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/88279) in GitLab 16.8 with a flag named `add_branch_rules`. Disabled by default.
> - Feature flag `add_branch_rules` [renamed](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/88279) to `edit_branch_rules` in GitLab 16.11. Disabled by default.
> - [Enabled on GitLab.com](https://gitlab.com/gitlab-org/gitlab/-/issues/454501) in GitLab 17.4.
FLAG:
On self-managed GitLab, by default this feature is not available. To make it available per project or for your entire instance, an administrator can [enable the feature flag](../../../../administration/feature_flags.md) named `edit_branch_rules`.
The availability of this feature is controlled by a feature flag. For more information, see the history.
Prerequisites:
- You must have at least the Maintainer role for the project.
To delete a branch rule:
1. On the left sidebar, select **Search or go to** and find your project.
1. Select **Settings > Repository**.
1. Expand **Branch rules**.
1. Next to a rule you want to delete, select **View details**.
1. In the upper-right corner, select **Delete rule**.
1. On the confirmation dialog, select **Delete branch rule**.
ensure your branches receive oversight and quality checks from their creation to their deletion. To view and edit branch protections, see [Branch rules](branch_rules.md).
## Compare branches
......
doc/user/project/repository/branches/protected.md
+ 4
− 4
浏览文件 @ f5850ab4
......@@ -200,7 +200,7 @@ check in directly to a protected branch:
1. From the **Allowed to push and merge** list, select **No one**.
1. Select **Protect**.
Alternatively, you can [create](index.md#create-a-branch-rule) or [edit](index.md#edit-a-branch-rule) a branch rule. Then:
Alternatively, you can [create](branch_rules.md#create-a-branch-rule) or [edit](branch_rules.md#edit-a-branch-rule-target) a branch rule. Then:
1. Select **Edit** in the **Allowed to merge** section.
1. Select **Developers and Maintainers**.
......@@ -218,7 +218,7 @@ You can allow everyone with write access to push to the protected branch.
1. From the **Allowed to push and merge** list, select **Developers + Maintainers**.
1. Select **Protect**.
Alternatively, you can [create](index.md#create-a-branch-rule) or [edit](index.md#edit-a-branch-rule) a branch rule. Then:
Alternatively, you can [create](branch_rules.md#create-a-branch-rule) or [edit](branch_rules.md#edit-a-branch-rule-target) a branch rule. Then:
1. Select **Edit** in the **Allowed to push and merge** section.
1. Select **Developers and Maintainers**.
......@@ -275,7 +275,7 @@ To enable force pushes on branches that are already protected:
1. Select **Add protected branch**.
1. In the list of protected branches, next to the branch, turn on the **Allowed to force push** toggle.
Alternatively, you can [create](index.md#create-a-branch-rule) or [edit](index.md#edit-a-branch-rule) a branch rule. Then:
Alternatively, you can [create](branch_rules.md#create-a-branch-rule) or [edit](branch_rules.md#edit-a-branch-rule-target) a branch rule. Then:
1. In the list of protected branches, next to the branch, turn on the **Allowed to force push** toggle.
......@@ -329,7 +329,7 @@ To enable Code Owner's approval on branches that are already protected:
1. Select **Add protected branch**.
1. In the list of protected branches, next to the branch, turn on the **Code owner approval** toggle.
Alternatively, you can [create](index.md#create-a-branch-rule) or [edit](index.md#edit-a-branch-rule) a branch rule.
Alternatively, you can [create](branch_rules.md#create-a-branch-rule) or [edit](branch_rules.md#edit-a-branch-rule-target) a branch rule.
Then, in the list of protected branches, next to the branch,
turn on the **Code owner approval** toggle.
......
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或