summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRémy Coutable <remy@rymai.me>2016-06-07 09:52:28 +0200
committerRémy Coutable <remy@rymai.me>2016-06-07 10:11:29 +0200
commitba466c861ec9ed693c45e1c844be6c75ef342da1 (patch)
tree93b79e66d9877d9e7e6f91fd694323a8dcf03fb9
parentbe04193433ea6fc1eee57b6eb7da369cf307ed64 (diff)
downloadgitlab-ce-jakubgarfield/gitlab-ce-branch_protection_regex.tar.gz
Add documentation for the auto-protected branches featurejakubgarfield/gitlab-ce-branch_protection_regex
Signed-off-by: Rémy Coutable <remy@rymai.me>
-rw-r--r--doc/workflow/protected_branches.md18
-rw-r--r--doc/workflow/protected_branches/protected_branches1.pngbin170113 -> 145093 bytes
-rw-r--r--doc/workflow/protected_branches/protected_branches2.pngbin25851 -> 18799 bytes
-rw-r--r--doc/workflow/protected_branches/protected_branches3.pngbin0 -> 42757 bytes
4 files changed, 17 insertions, 1 deletions
diff --git a/doc/workflow/protected_branches.md b/doc/workflow/protected_branches.md
index d854ec1e025..816d8413353 100644
--- a/doc/workflow/protected_branches.md
+++ b/doc/workflow/protected_branches.md
@@ -28,4 +28,20 @@ For those workflows, you can allow everyone with write access to push to a prote
On already protected branches you can also allow developers to push to the repository by selecting the `Developers can push` check box.
-![Developers can push](protected_branches/protected_branches2.png) \ No newline at end of file
+![Developers can push](protected_branches/protected_branches2.png)
+
+## Automatically-protect new branches that match a regex pattern
+
+Some workflows, like [GitLab workflow](gitlab_flow.md#release-branches-with-gitlab-flow),
+requires that new branches (e.g. "release" branches) are created on a regular
+basis. Most of the time, these branches are created by automated scripts.
+Since these branches must be protected and follow a known pattern, they can be
+automatically protected as soon as they are pushed to GitLab.
+
+To enable the auto-protection of branches, navigate to the project settings pages,
+and enter the regex pattern that branches should match in the `Auto-protected
+branch pattern` text field. You can also allow everyone with write access to push
+to a new auto-protected branch by selecting the `Developers can push to
+auto-protected branches` check box.
+
+![Auto-protected branches](protected_branches/protected_branches3.png)
diff --git a/doc/workflow/protected_branches/protected_branches1.png b/doc/workflow/protected_branches/protected_branches1.png
index 5c2a3de5f70..a484f5fe29d 100644
--- a/doc/workflow/protected_branches/protected_branches1.png
+++ b/doc/workflow/protected_branches/protected_branches1.png
Binary files differ
diff --git a/doc/workflow/protected_branches/protected_branches2.png b/doc/workflow/protected_branches/protected_branches2.png
index 2dca3541365..1b23e931f57 100644
--- a/doc/workflow/protected_branches/protected_branches2.png
+++ b/doc/workflow/protected_branches/protected_branches2.png
Binary files differ
diff --git a/doc/workflow/protected_branches/protected_branches3.png b/doc/workflow/protected_branches/protected_branches3.png
new file mode 100644
index 00000000000..ea31cb2e458
--- /dev/null
+++ b/doc/workflow/protected_branches/protected_branches3.png
Binary files differ