Commit 91561638 authored by Achilleas Pipinellis's avatar Achilleas Pipinellis

Document the new behavior of protected branches

parent 3851c497
...@@ -28,26 +28,60 @@ that the `master` branch is protected by default. ...@@ -28,26 +28,60 @@ that the `master` branch is protected by default.
1. From the **Branch** dropdown menu, select the branch you want to protect and 1. From the **Branch** dropdown menu, select the branch you want to protect and
click **Protect**. In the screenshot below, we chose the `develop` branch. click **Protect**. In the screenshot below, we chose the `develop` branch.
![Choose protected branch](img/protected_branches_choose_branch.png) ![Protected branches page](img/protected_branches_page.png)
1. Once done, the protected branch will appear in the "Already protected" list. 1. Once done, the protected branch will appear in the "Already protected" list.
![Protected branches list](img/protected_branches_list.png) ![Protected branches list](img/protected_branches_list.png)
## Using the Allowed to merge and Allowed to push settings
Since GitLab 8.10, we added another layer of branch protection which provides > This feature was [introduced][ce-5081] in GitLab 8.11.
more granular management of protected branches. You can now choose the option
"Developers can merge" so that Developer users can merge a merge request but
not directly push. In that case, your branches are protected from direct pushes,
yet Developers don't need elevated permissions or wait for someone with a higher
permission level to press merge.
You can set this option while creating the protected branch or after its Since GitLab 8.11, we added another layer of branch protection which provides
creation. more granular management of protected branches. The "Developers can push"
option was replaced by an "Allowed to push" setting which can be set to
allow/prohibit Masters and/or Developers to push to a protected branch.
Using the "Allowed to push" and "Allowed to merge" settings, you can control
the actions that different roles can perform with the protected branch.
For example, you could set "Allowed to push" to "No one", and "Allowed to merge"
to "Developers + Masters", to require _everyone_ to submit a merge request for
changes going into the protected branch. This is compatible with workflows like
the [GitLab workflow](../../workflow/gitlab_flow.md).
However, there are workflows where that is not needed, and only protecting from
force pushes and branch removal is useful. For those workflows, you can allow
everyone with write access to push to a protected branch by setting
"Allowed to push" to "Developers + Masters".
You can set the "Allowed to push" and "Allowed to merge" options while creating
a protected branch or afterwards by selecting the option you want from the
dropdown list in the "Already protected" area.
![Developers can push](img/protected_branches_devs_can_push.png)
If you don't choose any of those options while creating a protected branch,
they are set to "Masters" by default.
## Restricting push and merge access to certain users
> This feature was [introduced][ce-5081] in GitLab Enterprise Edition 8.11.
With GitLab Enterprise Edition you can restrict access to protected branches
by choosing a role (Masters, Developers) as well as certain users. From the
dropdown menu select the role and/or the users you want to have merge or push
access.
![Select roles and users](img/protected_branches_select_roles_and_users.png)
Click **Protect** and the branch will appear in the "Protected branch" list.
![Roles and users list](img/protected_branches_select_roles_and_users_list.png)
## Wildcard protected branches ## Wildcard protected branches
> [Introduced][ce-4665] in GitLab 8.10. > This feature was [introduced][ce-4665] in GitLab 8.10.
You can specify a wildcard protected branch, which will protect all branches You can specify a wildcard protected branch, which will protect all branches
matching the wildcard. For example: matching the wildcard. For example:
...@@ -66,38 +100,19 @@ Two different wildcards can potentially match the same branch. For example, ...@@ -66,38 +100,19 @@ Two different wildcards can potentially match the same branch. For example,
In that case, if _any_ of these protected branches have a setting like In that case, if _any_ of these protected branches have a setting like
"Allowed to push", then `production-stable` will also inherit this setting. "Allowed to push", then `production-stable` will also inherit this setting.
If you click on a protected branch's name that is created using a wildcard, If you click on a protected branch's name, you will be presented with a list of
you will be presented with a list of all matching branches: all matching branches:
![Protected branch matches](img/protected_branches_matches.png) ![Protected branch matches](img/protected_branches_matches.png)
## Restrict the creation of protected branches ## Restrict the creation of protected branches
Creating a protected branch or a list of protected branches using the wildcard
feature, not only you are restricting pushes to those branches, but also their
creation if not already created.
## Error messages when pushing to a protected branch
A user with insufficient permissions will be presented with an error when
creating or pushing to a branch that's prohibited, either through GitLab's UI:
![Protected branch error GitLab UI](img/protected_branches_error_ui.png)
or using Git from their terminal:
```bash
remote: GitLab: You are not allowed to push code to protected branches on this project.
To https://gitlab.example.com/thedude/bowling.git
! [remote rejected] staging-stable -> staging-stable (pre-receive hook declined)
error: failed to push some refs to 'https://gitlab.example.com/thedude/bowling.git'
```
## Changelog ## Changelog
**8.10.0** **8.10**
- Allow specifying protected branches using wildcards [gitlab-org/gitlab-ce!5081][ce-4665] - Allow specifying protected branches using wildcards [gitlab-org/gitlab-ce!5081][ce-5081]
- Allow creating protected branches that can't be pushed to [gitlab-org/gitlab-ce!5081][ce-4665]
--- ---
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment