Merge Request

What is the purpose of the Article?

You will understand about creating a merge request in Gitlab in Eshopbox.
You will understand the types of merge request and their use-cases.

Audience

Software Development Engineers

When is a merge request created?

A merge request is created when one wishes to merge its code from a branch with the other branch.

There are two types of merge request:

An approver is required to complete the merge request
An approver is NOT required to complete the merge request

Stakeholders involved in a merge request in Gitlab:

Author: The author is the person who is creating the merge request
Assignee: The assignee is the person to whom the merge request is assigned to be merged after approval of the approver.
Approver: The approver is the person who approves the merge request after reviewing the code.
Reviewer: The reviewer is the person who reviews the merge request.

Type-1: An Approver is required to complete the merge request

You are required to follow this process in the following instances:

When merging from Work-in-progress (WIP) branch to Feature branch
When merging from Feature branch to Version branch
When merging Conflict branch to another branch

Step by Step guide

Whenever creating/making a merge request in Gitlab map your JIRA issue with your merge request by mentioning the JIRA ISSUE ID in the Title. You are allowed to mention multiple Jira Issue ID's if the merge request relates to multiple issues in Jira.
Whenever creating a merge request in Gitlab, the Author of the merge request must select at least 1 Assignee, 1 Approver and 1 Reviewer. Selecting an assignee, approver and reviewer is mandatory. In Eshopbox, the Assignee, Approver and Reviewer selected is the same roleplayer
The Author is required to add a screenshot attachment for the 95% API latency from the endpoints console of the Google cloud project to ensure the API performance.
The approver is required to ensure that the screenshot is attached before initiating the approval process.
Approver/Reviewer will first review the code.
It is mandatory for the Approver/Reviewer to add comments when reviewing and approving a merge request. Comments must include what has been reviewed and what were the rules/guidelines.
If suggested changes are to be made after Approver’s review, the Approver will contact the Author for immediate action. If no changes are to be made after review, the Approver will click on “Approve”
After clicking on Approve, the Merge button will be highlighted, as shown below.
2. The Approver will now Click on Merge.
The Merge request process is completed. If there are any changes required to be done by the Author, the Author will make changes and re-initiate the “step by step” process.

Type-2: An Approver is NOT required to complete the merge request

You are required to follow this process in the following instances:

When merging from Feature branch to Staging branch
When merging from Version branch to Stable branch
When merging from Version branch to Master branch

Step by Step guide

Whenever creating/making a merge request in Gitlab map your JIRA issue with your merge request by mentioning the JIRA ISSUE ID in the Title. You are allowed to mention multiple Jira Issue ID's if the merge request relates to multiple issues in Jira.
Whenever creating a merge request in Gitlab, the Author of the merge request must select at least 1 Assignee and 1 Approver. Although in this case, an Approver is not required to complete the Merge request, therefore selecting an assignee is mandatory to fulfill the rules. In Eshopbox, the Assignee and Approver selected is the same roleplayer.
The Author is required to Click on Merge as shown below
The merge request process is completed.

For WIP to Feature merge requests:

1.Assign the label "WIP to Feature" whenever you create a merge request from your WIP branch to the Feature branch.

2.Add "WIP to Feature" at the start of your merge request title for merge requests from WIP to Feature branches.

Software Development