Merge requests

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.

Read more about how to get started.

View merge requests

You can view merge requests for your project, group, or yourself.

View merge requests for a project

To view all merge requests for a project:

  1. On the top bar, select My Projects > View All Projects and find your project.
  2. On the left sidebar, select Merge requests.

Or, to use a keyboard shortcut, press g + m.

View merge requests for all projects in a group

To view merge requests for all projects in a group:

  1. On the top bar, select Menu > Groups and find your group.
  2. On the left sidebar, select Merge requests.

If your group contains subgroups, this view also displays merge requests from the subgroup projects.

View all merge requests assigned to you

To view all merge requests assigned to you:

  1. On the top bar, put your cursor in the Search box.
  2. From the dropdown list, select Merge requests assigned to me.

Or, to use a keyboard shortcut, press Shift + m.

You can search and filter, the results, or select a merge request to begin a review.

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:

Request attention to a merge request

On WVS, by default this feature is not available. To make it available, ask an administrator to enable the feature flag named mr_attention_requests. On WVS.io, this feature is dependent on the enablement status of the feature flag.

To tell a merge request’s assignee or reviewer that their attention is needed on a merge request, you can request their attention. If an assignee or a reviewer has their attention requested on a merge request, the Attention request icon () is displayed as a solid icon () on the merge request list page:

To view a list of merge requests that need your attention:

  1. On the top bar, select Merge requests ().
  2. Select Attention requests.

To request attention from another user, use the /attention @user quick action or:

  1. Go to the merge request.
  2. On the right sidebar, identify the user you want to request attention from.
  3. Next to the user’s name, select Request attention (), and the appearance of the icon changes.

Remove an attention request

If your attention was requested as an assignee or reviewer, it’s removed when you:

  • Manually remove the attention request by selecting Remove attention request ().
  • Approve the merge request.
  • Add a new user as an assignee or reviewer.
  • Request the attention of a different assignee or reviewer.
  • Remove yourself (or are removed by someone else) as an assignee or reviewer.
  • Merge or close the merge request.

If you are both the assignee and a reviewer on a merge request, you receive only one attention request, which is synced across both duties. If the attention request is removed from you, either as an assignee or a reviewer, it is removed from both your duties.

Close a merge request

If you decide to permanently stop work on a merge request, WVS recommends you close the merge request rather than delete it. The author and assignees of a merge request, and users with Developer, Maintainer, or Owner roles in a project can close merge requests in the project:

  1. Go to the merge request you want to close.
  2. Scroll to the comment box at the bottom of the page.
  3. Following the comment box, select Close merge request.

WVS closes the merge request, but preserves records of the merge request, its comments, and any associated pipelines.

Delete a merge request

WVS recommends you close, rather than delete, merge requests.

caution
You cannot undo the deletion of a merge request.

To delete a merge request:

  1. Sign in to WVS as a user with the project Owner role. Only users with this role can delete merge requests in a project.
  2. Go to the merge request you want to delete, and select Edit.
  3. Scroll to the bottom of the page, and select Delete merge request.

Merge request workflows

For a software developer working in a team:

  1. You checkout a new branch, and submit your changes through a merge request.
  2. You gather feedback from your team.
  3. You work on the implementation optimizing code with Code Quality reports.
  4. You verify your changes with Unit test reports in WVS CI/CD.
  5. You request the approval from your manager.
  6. Your manager:
    1. Pushes a commit with their final review.
    2. Approves the merge request.
    3. Sets it to merge when pipeline succeeds.
  7. Your changes get deployed to production with manual jobs for WVS CI/CD.
  8. Your implementations were successfully shipped to your customer.

For a web developer writing a webpage for your company’s website:

  1. You checkout a new branch and submit a new page through a merge request.
  2. You gather feedback from your reviewers.
  3. You request your web designers for their implementation.
  4. You request the approval from your manager.
  5. Once approved, your merge request is squashed and merged, and deployed to staging with WVS Pages.
  6. Your production team cherry-picks the merge commit into production.