Merge requests (FREE)
Merge requests (MRs) are the way you check source code changes into a branch. When you open a merge request, you can visualize and collaborate on the code changes before merge. Merge requests include:
- A description of the request.
- Code changes and inline code reviews.
- Information about CI/CD pipelines.
- A comment section for discussion threads.
- The list of commits.
To get started, read the introduction to merge requests.
Merge request tabs
Merge requests contain tabs at the top of the page to help you navigate to important parts of the merge request:
- Overview: Contains the description, notifications from pipelines, and a discussion area for comment threads and code suggestions. The right sidebar provides fields to add assignees, reviewers, labels, and a milestone to your work, and the merge request widgets area reports results from pipelines and tests.
- Commits: Contains a list of commits added to this merge request. For more information, read Commits tab in merge requests.
- Pipelines: If configured, contains a list of recent GitLab CI/CD pipelines and their status.
- Changes: Contains the diffs of files changed by this merge request. You can configure the display.
View merge requests
To view a list of merge requests:
- Merge requests for a project: Go to your project and select Merge requests, or use the g + m keyboard shortcut from a page in your project.
- All projects in a group: Go to your group and select Merge requests. If your group contains subgroups, this view also displays merge requests from the subgroup projects. GitLab displays a count of open merge requests in the left sidebar, but caches the value for groups with a large number of open merge requests.
- Merge requests assigned to you: On any GitLab page, select Merge requests in the top bar, or use the Shift + m global keyboard shortcut.
GitLab displays open merge requests, with tabs to filter the list by open and closed status:
You can search and filter, the results, or select a merge request to begin a review.
Merge request sidebar
The Overview tab of a merge request displays a sidebar. In this sidebar, you can assign, categorize, and track progress on a merge request:
- Assignee: Designate the directly responsible individual (DRI) for a merge request. With multiple assignees, you can assign a merge request to more than one person at a time.
- Reviewer: Designate a team member to review a merge request. Higher tiers can assign multiple reviewers, and require approvals from these reviewers.
- Milestone: Track time-sensitive changes.
- Time tracking: Time spent on a merge request.
- Labels: Categorize a merge request and display it on appropriate issue boards.
- Participants: A list of users participating or watching a merge request.
- Notifications: A toggle to select whether or not to receive notifications for updates to a merge request.
Add changes to a merge request
If you have permission to add changes to a merge request, you can add your changes to an existing merge request in several ways, depending on the complexity of your change and whether you need access to a development environment:
- Edit changes in the Web IDE in your browser. Use this browser-based method to edit multiple files, or if you are not comfortable with Git commands. You cannot run tests from the Web IDE.
- Edit changes in Gitpod, if you need a fully-featured environment to both edit files, and run tests afterward. Gitpod supports running the GitLab Development Kit (GDK). To use Gitpod, you must enable Gitpod in your user account.
- Push changes from the command line, if you are familiar with Git and the command line.
Close a merge request
If you decide to permanently stop work on a merge request, GitLab recommends you close the merge request rather than delete it. Users with Developer, Maintainer, or Owner roles in a project can close merge requests in the project:
- Go to the merge request you want to close.
- Scroll to the comment box at the bottom of the page.
- Following the comment box, select Close merge request.
GitLab closes the merge request, but preserves records of the merge request, its comments, and any associated pipelines.
Delete a merge request
GitLab recommends you close, rather than delete, merge requests.
WARNING: You cannot undo the deletion of a merge request.
To delete a merge request:
- Sign in to GitLab as a user with the project Owner role. Only users with this role can delete merge requests in a project.
- Go to the merge request you want to delete, and select Edit.
- Scroll to the bottom of the page, and select Delete merge request.
Merge request workflows
For a software developer working in a team:
- You checkout a new branch, and submit your changes through a merge request.
- You gather feedback from your team.
- You work on the implementation optimizing code with Code Quality reports.
- You verify your changes with Unit test reports in GitLab CI/CD.
- You avoid using dependencies whose license is not compatible with your project with License Compliance reports.
- You request the approval from your manager.
- Your manager:
- Your changes get deployed to production with manual jobs for GitLab CI/CD.
- Your implementations were successfully shipped to your customer.
For a web developer writing a webpage for your company's website:
- You checkout a new branch and submit a new page through a merge request.
- You gather feedback from your reviewers.
- You preview your changes with Review Apps.
- You request your web designers for their implementation.
- You request the approval from your manager.
- Once approved, your merge request is squashed and merged, and deployed to staging with GitLab Pages.
- Your production team cherry-picks the merge commit into production.