Commit b5afc245 authored by Achilleas Pipinellis's avatar Achilleas Pipinellis

Merge branch 'docs-branch-from-issue' into 'master'

Docs: update "branch from issue" documentation

See merge request gitlab-org/gitlab!21118
parents c90c0262 9d56c6a5
...@@ -31,6 +31,8 @@ also appear in the top right of the: ...@@ -31,6 +31,8 @@ also appear in the top right of the:
In this case, the merge request will use the most recent branch you pushed changes In this case, the merge request will use the most recent branch you pushed changes
to as the source branch, and `master` in the current project as the target. to as the source branch, and `master` in the current project as the target.
You can also [create a new merge request directly from an issue](../repository/web_editor.md#create-a-new-branch-from-an-issue).
## Workflow for new merge requests ## Workflow for new merge requests
On the **New Merge Request** page, you can start by filling in the title and description On the **New Merge Request** page, you can start by filling in the title and description
......
...@@ -95,20 +95,31 @@ There are multiple ways to create a branch from GitLab's web interface. ...@@ -95,20 +95,31 @@ There are multiple ways to create a branch from GitLab's web interface.
In case your development workflow dictates to have an issue for every merge 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 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 tied with the issue itself. You can see a **Create merge request** dropdown
description, unless there is already a branch with the same name or a referenced below the issue description unless there is already a branch with the same
merge request. name or a referenced merge request.
![New Branch Button](img/web_editor_new_branch_from_issue.png) ![Create Button](img/web_editor_new_branch_from_issue_create_button_v12_6.png)
Once you click it, a new branch will be created that diverges from the default This dropdown contains the options **Create merge request and branch** and **Create branch**.
![New Branch Button](img/web_editor_new_branch_from_issue_v_12_6.png)
Once you choose one of these options, a new branch or branch and merge request
will be created, based on the default
branch of your project, by default `master`. The branch name will be based on branch of your project, by default `master`. The branch name will be based on
the title of the issue and as a prefix, it will have its internal ID. Thus, the example the title of the issue and as a prefix, it will have its internal ID. Thus, the example
screenshot above will yield a branch named screenshot above will create a branch named
`23177-add-support-for-rich-references-to-referables`. `2-make-static-site-auto-deploy-and-serve`.
Since GitLab 9.0, when you click the `New branch` in an empty repository project, GitLab automatically creates the master branch, commits a blank `README.md` file to it and creates and redirects you to a new branch based on the issue title. When you click the **Create branch** button in an empty
If your [project is already configured with a deployment service][project-services-doc] (e.g. Kubernetes), GitLab takes one step further and prompts you to set up [auto deploy][auto-deploy-doc] by helping you create a `.gitlab-ci.yml` file. repository project, GitLab automatically creates a `master` branch, commits
a blank `README.md` file to it, and creates and redirects you to a new branch
based on the issue title.
If your [project is already configured with a deployment service](../integrations/project_services.md),
such as Kubernetes, GitLab takes one step further and prompts you to set up
[auto deploy](../../../topics/autodevops/index.md#auto-deploy)
by helping you create a `.gitlab-ci.yml` file.
After the branch is created, you can edit files in the repository to fix 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 issue. When a merge request is created based on the newly created branch,
...@@ -116,9 +127,6 @@ the description field will automatically display the [issue closing pattern](../ ...@@ -116,9 +127,6 @@ 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 `Closes #ID`, where `ID` the ID of the issue. This will close the issue once the
merge request is merged. merge request is merged.
[project-services-doc]: ../integrations/project_services.md
[auto-deploy-doc]: ../../../topics/autodevops/index.md#auto-deploy
### Create a new branch from a project's dashboard ### Create a new branch from a project's dashboard
If you want to make changes to several files before creating a new merge If you want to make changes to several files before creating a new merge
......
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