gitlab-org--gitlab-foss/doc/user/project/merge_requests/creating_merge_requests.md

6.7 KiB

stage group info description disqus_identifier
Create Code Review To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments How to create merge requests in GitLab. https://docs.gitlab.com/ee/gitlab-basics/add-merge-request.html

Creating merge requests (FREE)

There are many different ways to create a merge request.

From the merge request list

You can create a merge request from the list of merge requests.

  1. On the top bar, select Menu > Projects and find your project.
  2. On the left menu, select Merge requests.
  3. In the top right, select New merge request.
  4. Select a source and target branch and then Compare branches and continue.
  5. Fill out the fields and select Create merge request.

NOTE: Merge requests are designed around a one-to-one (1:1) branch relationship. Only one open merge request may be associated with a given target branch at a time.

From an issue

You can create a merge request from an issue.

When you add, edit, or upload a file

You can create a merge request when you add, edit, or upload a file to a repository.

  1. Add, edit, or upload a file to the repository.
  2. In the Commit message, enter a reason for the commit.
  3. Select the Target branch or create a new branch by typing the name (without spaces, capital letters, or special chars).
  4. Select the Start a new merge request with these changes checkbox or toggle. This checkbox or toggle is visible only if the target is not the same as the source branch, or if the source branch is protected.
  5. Select Commit changes.

When you create a branch

You can create a merge request when you create a branch.

  1. On the top bar, select Menu > Projects and find your project.
  2. On the left menu, select Repository > Branches.
  3. Type a branch name and select New branch.
  4. Above the file list, on the right side, select Create merge request. A merge request is created. The default branch is the target.
  5. Fill out the fields and select Create merge request.

When you use Git commands locally

You can create a merge request by running Git commands on your local machine.

  1. Create a branch:

    git checkout -b my-new-branch
    
  2. Create, edit, or delete files. The stage and commit them:

    git add .
    git commit -m "My commit message"
    
  3. Push your branch to GitLab:

    git push origin my-new-branch
    

    GitLab prompts you with a direct link for creating a merge request:

    ...
    remote: To create a merge request for my-new-branch, visit:
    remote:   https://gitlab.example.com/my-group/my-project/merge_requests/new?merge_request%5Bsource_branch%5D=my-new-branch
    
  4. Copy the link and paste it in your browser.

You can add other flags to commands when pushing through the command line to reduce the need for editing merge requests manually through the UI.

When you work in a fork

You can create a merge request from your fork to contribute back to the main project.

  1. On the top bar, select Menu > Project.
  2. Select your fork of the repository.
  3. On the left menu, go to Merge requests, and select New merge request.
  4. In the Source branch drop-down list box, select the branch in your forked repository as the source branch.
  5. In the Target branch drop-down list box, select the branch from the upstream repository as the target branch. You can set a default target project to change the default target branch (which can be useful if you are working in a forked project).
  6. Select Compare branches and continue.
  7. Select Submit merge request.

After your work is merged, if you don't intend to make any other contributions to the upstream project, you can unlink your fork from its upstream project. Go to Settings > Advanced Settings and remove the forking relationship.

For more information, see the forking workflow documentation.

By sending an email

You can create a merge request by sending an email message to GitLab. The merge request target branch is the project's default branch.

Prerequisites:

To create a merge request by sending an email:

  1. On the top bar, select Menu > Projects and find your project.

  2. On the left menu, select Merge requests.

  3. In the top right, select Email a new merge request to this project. An email address is displayed. Copy this address. Ensure you keep this address private.

  4. Open an email and compose a message with the following information:

    • The To line is the email address you copied.
    • The subject line is the source branch name.
    • The message body is the merge request description.
  5. Send the email message.

A merge request is created.

Add attachments when creating a merge request by email

You can add commits to a merge request by adding patches as attachments to the email. All attachments with a filename ending in .patch are considered patches and are processed ordered by name.

The combined size of the patches can be 2 MB.

If the source branch from the subject does not exist, it is created from the repository's HEAD or the specified target branch. You can specify the target branch by using the /target_branch quick action. If the source branch already exists, the patches are applied on top of it.

Set the default target project

Introduced in GitLab 13.11.

Merge requests have a source and a target project that are the same, unless forking is involved. Creating a fork of the project can cause either of these scenarios when you create a new merge request:

  • You target an upstream project (the project you forked, and the default option).
  • You target your own fork.

To have merge requests from a fork by default target your own fork (instead of the upstream project), you can change the default.

  1. On the top bar, select Menu > Project.
  2. On the left menu, select Settings > General > Merge requests.
  3. In the Target project section, select the option you want to use for your default target project.
  4. Select Save changes.