diff options
author | Achilleas Pipinellis <axilleas@axilleas.me> | 2016-04-13 09:02:14 +0000 |
---|---|---|
committer | Achilleas Pipinellis <axilleas@axilleas.me> | 2016-04-13 09:02:14 +0000 |
commit | 6bb71869b8c003e9e880646afa35050821e7dac9 (patch) | |
tree | 941f2a4c63f2936d28e843e1d1ef5e24fa4706a0 /doc | |
parent | 57e660d8f3eae731e63c934416b4802ee3c45a23 (diff) | |
parent | 4a09a6c6f21c0bcd48123759cd6804276d810929 (diff) | |
download | gitlab-ce-6bb71869b8c003e9e880646afa35050821e7dac9.tar.gz |
Merge branch 'docs-new-branch-button-3886' into 'master'
Docs for the new branch button
[ci-skip]
Closes #3886
@axil Could you check this and make sure this is up to your standards?
See merge request !3425
Diffstat (limited to 'doc')
-rw-r--r-- | doc/workflow/img/new_branch_from_issue.png | bin | 0 -> 120622 bytes | |||
-rw-r--r-- | doc/workflow/web_editor.md | 32 |
2 files changed, 32 insertions, 0 deletions
diff --git a/doc/workflow/img/new_branch_from_issue.png b/doc/workflow/img/new_branch_from_issue.png Binary files differnew file mode 100644 index 00000000000..394c139e17e --- /dev/null +++ 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. + +![New Branch Button](img/new_branch_from_issue.png) + +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. ![Start a new merge request with these changes](img/web_editor_start_new_merge_request.png) + +[ce-2808]: https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/2808 +[issue closing pattern]: ../customization/issue_closing.md |