diff options
| -rw-r--r-- | doc/gitlab-basics/create-branch.md | 9 | ||||
| -rw-r--r-- | doc/workflow/img/new_branch_from_issue.png (renamed from doc/gitlab-basics/basicsimages/new_branch_button.png) | bin | 120622 -> 120622 bytes | |||
| -rw-r--r-- | doc/workflow/web_editor.md | 32 |
3 files changed, 32 insertions, 9 deletions
diff --git a/doc/gitlab-basics/create-branch.md b/doc/gitlab-basics/create-branch.md index 9d688b9389b..7556b0f663e 100644 --- a/doc/gitlab-basics/create-branch.md +++ b/doc/gitlab-basics/create-branch.md @@ -32,15 +32,6 @@ Fill out the information required:  -## From an issue -When an issue should be resolved one could also create a branch on the issue page. A button is displayed after the description unless there is already a branch or a referenced merge request. - - - -The branch created diverges from the default branch of the project, usually `master`. The branch name will be based on the title of the issue and as suffix its ID. Thus the example screenshot above will yield a branch named `et-cum-et-sed-expedita-repellat-consequatur-ut-assumenda-numquam-rerum-2`. -After the branch is created the user can edit files in the repository to fix the issue. When a merge request is created the -description field will display `Closes #2` to use the issue closing pattern. This will close the issue once the merge request is merged. - ### Note: You will be able to find and select the name of your branch in the white box next to a project's name: diff --git a/doc/gitlab-basics/basicsimages/new_branch_button.png b/doc/workflow/img/new_branch_from_issue.png Binary files differindex 394c139e17e..394c139e17e 100644 --- a/doc/gitlab-basics/basicsimages/new_branch_button.png +++ b/doc/workflow/img/new_branch_from_issue.png diff --git a/doc/workflow/web_editor.md b/doc/workflow/web_editor.md index 4a451d98953..5685a9d89dd 100644 --- a/doc/workflow/web_editor.md +++ b/doc/workflow/web_editor.md @@ -66,6 +66,35 @@ the target branch. Click **Create directory** to finish. ## Create a new branch +There are multiple ways to create a branch from GitLab's web interface. + +### Create a new branch from an issue + +>**Note:** +This feature was [introduced][ce-2808] in GitLab 8.6. + +In case your development workflow dictates to have an issue for every merge +request, you can quickly create a branch right on the issue page which will be +tied with the issue itself. You can see a **New Branch** button after the issue +description, unless there is already a branch with the same name or a referenced +merge request. + + + +Once you click it, a new branch will be created that diverges from the default +branch of your project, by default `master`. The branch name will be based on +the title of the issue and as suffix it will have its ID. Thus, the example +screenshot above will yield a branch named +`et-cum-et-sed-expedita-repellat-consequatur-ut-assumenda-numquam-rerum-2`. + +After the branch is created, you can edit files in the repository to fix +the issue. When a merge request is created based on the newly created branch, +the description field will automatically display the [issue closing pattern] +`Closes #ID`, where `ID` the ID of the issue. This will close the issue once the +merge request is merged. + +### Create a new branch from a project's dashboard + If you want to make changes to several files before creating a new merge request, you can create a new branch up front. From a project's files page, choose **New branch** from the dropdown. @@ -118,3 +147,6 @@ appear that is labeled **Start a new merge request with these changes**. After you commit the changes you will be taken to a new merge request form.  + +[ce-2808]: https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/2808 +[issue closing pattern]: ../customization/issue_closing.md |
