summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMarcia Ramos <virtua.creative@gmail.com>2017-06-16 14:31:46 +0000
committerMarcia Ramos <virtua.creative@gmail.com>2017-06-16 14:31:46 +0000
commit5f42009f8dcc29d559ee415e92c88858e361f063 (patch)
tree6a3b05a5429a819489e256b9661abe6c1914074f
parentbcb7d88504f4f99a4e359730f342e1a88392508a (diff)
parent631524587eebbb204b057c9d356384a44b324460 (diff)
downloadgitlab-ce-5f42009f8dcc29d559ee415e92c88858e361f063.tar.gz
Merge branch 'docs/branches' into 'master'
Document the Delete Merged Branches functionality See merge request !12217
-rw-r--r--changelogs/unreleased/33445-document-delete-merge-branches-won-t-touch-protected-branches-docs.yml4
-rw-r--r--doc/README.md1
-rw-r--r--doc/api/branches.md2
-rw-r--r--doc/user/project/repository/branches/img/delete_merged_branches.pngbin0 -> 42891 bytes
-rw-r--r--doc/user/project/repository/branches/index.md17
5 files changed, 24 insertions, 0 deletions
diff --git a/changelogs/unreleased/33445-document-delete-merge-branches-won-t-touch-protected-branches-docs.yml b/changelogs/unreleased/33445-document-delete-merge-branches-won-t-touch-protected-branches-docs.yml
new file mode 100644
index 00000000000..385f18e2560
--- /dev/null
+++ b/changelogs/unreleased/33445-document-delete-merge-branches-won-t-touch-protected-branches-docs.yml
@@ -0,0 +1,4 @@
+---
+title: Document the Delete Merged Branches functionality
+merge_request:
+author:
diff --git a/doc/README.md b/doc/README.md
index 9f12eed1471..775fffab2dd 100644
--- a/doc/README.md
+++ b/doc/README.md
@@ -59,6 +59,7 @@ Manage files and branches from the UI (user interface):
- Branches
- [Create a branch](user/project/repository/web_editor.md#create-a-new-branch)
- [Protected branches](user/project/protected_branches.md#protected-branches)
+ - [Delete merged branches](user/project/repository/branches/index.md#delete-merged-branches)
### Issues and Merge Requests (MRs)
diff --git a/doc/api/branches.md b/doc/api/branches.md
index 325d0ea4ce3..dfaa7d6fab7 100644
--- a/doc/api/branches.md
+++ b/doc/api/branches.md
@@ -251,6 +251,8 @@ curl --request DELETE --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" "https://gi
Will delete all branches that are merged into the project's default branch.
+Protected branches will not be deleted as part of this operation.
+
```
DELETE /projects/:id/repository/merged_branches
```
diff --git a/doc/user/project/repository/branches/img/delete_merged_branches.png b/doc/user/project/repository/branches/img/delete_merged_branches.png
new file mode 100644
index 00000000000..1856a624f74
--- /dev/null
+++ b/doc/user/project/repository/branches/img/delete_merged_branches.png
Binary files differ
diff --git a/doc/user/project/repository/branches/index.md b/doc/user/project/repository/branches/index.md
new file mode 100644
index 00000000000..1948627ee79
--- /dev/null
+++ b/doc/user/project/repository/branches/index.md
@@ -0,0 +1,17 @@
+# Branches
+
+## Delete merged branches
+
+> [Introduced][ce-6449] in GitLab 8.14.
+
+![Delete merged branches](img/delete_merged_branches.png)
+
+This feature allows merged branches to be deleted in bulk. Only branches that
+have been merged and [are not protected][protected] will be deleted as part of
+this operation.
+
+It's particularly useful to clean up old branches that were not deleting
+automatically when a merge request was merged.
+
+[ce-6449]: https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/6449 "Add button to delete all merged branches"
+[protected]: ../../protected_branches.md