Approving Merge Requests using the MR Dashboard

The updates for this section are currently in progress.

Prerequisites

Before a Merge Request review/approval is requested, the following conditions must be met:

  • The Merge Request is no longer in draft form

  • A Merge Request review has been requested by the author.

  • The Issue related to the Merge Request contains a clear title and description outlining the proposed changes.

  • The changes have been pushed to the repository and are ready for assessment.

Video Walkthrough

Coming Soon

Step-by-Step Approval Process

1. Access the Merge Request Dashboard

  1. Navigate to the Merge Request Dashboard.

    train approve merge request 1

  2. Locate the section labeled "Reviews requested" to find MRs awaiting your review.

  3. Click on the Merge Request title to open the Merge Request page.

    train approve merge request 2

2. Key Components of a Merge Request

Use the image below as a reference. Open it in a new tab to expand for better visibility, and follow the callouts below for guidance.

train approve merge request 3

1 Merge Request Title The short, clear, and descriptive name of the Merge Request (MR). This should summarize the purpose of the changes being proposed.
2 Merge Request Description A brief explanation of what the MR does, including the reason for the changes, any relevant context, and links to related issues or discussions. This helps reviewers understand the purpose and scope of the MR.

Also, in section 2 of the image, notice the "Closes #7" link. This identifies the issue that this merge request was created for. The issue serves as the central reference point where all related changes, context, and contact information are documented

  • Navigate to the issue by clicking the "Closes #" link in the Merge Request description. This will take you to a detailed issue page, similar to the image below:

    train approve merge request 4

  • After reviewing the description of changes and any related activities, return to the Merge Request by clicking on the "Related merge request" link located just above the activities section of the issue.

    train approve merge request 5
3 Assignee The person responsible for addressing feedback and making updates to the Merge Request. This is typically the individual who created the MR or is tasked with implementing changes.
4 Reviewers A list of individuals or groups who are expected to review and provide feedback on the MR. Reviewers analyze the proposed changes and suggest improvements or approve the request.
5 Required Approvers Specific individuals or teams who must formally approve the Merge Request before it can be merged. Approval may be required from policy supervisors, leadership, legal, or compliance teams based on the nature of the changes.
6 Merge Status Indicates the current state of the Merge Request.

3. Examine the Commits

  1. Click on the "Commit" tab to view the modifications in the policy documentation.

train approve merge request 6

  1. Compare the new content with existing policy guidelines.

  2. Check for formatting consistency and adherence to style guidelines.

  3. Ensure that no unintended changes have been included.

Use the "Side-by-Side" diff view for easier comparison of changes.

train approve merge request 7

4. Provide Feedback or Request Modifications

  1. Navigate to the "Discussion" tab to add comments on any areas that need clarification or adjustments.

  2. If changes are required:

    • Click "Request Changes".

    • Provide specific comments and suggestions for improvement.

Be precise and constructive in your feedback to streamline the revision process.

5. Approve the Merge Request

  1. If the changes meet all requirements:

    • Click "Approve" to confirm the changes.

    • Optionally, leave a comment to confirm the review is complete.

  2. If additional approvals are needed, ensure all required approvers have completed their reviews before finalizing.

6. Merge the Request (if authorized)

  1. If you have merge permissions and all required approvals are in place:

    • Click "Merge" to integrate the changes into the repository.

    • Confirm that the branch is safely merged and delete it if necessary.

  2. If you do not have merge permissions, notify the repository owner or relevant team.

Troubleshooting Common Issues

Merge Request Not Ready for Review

  • Ensure the MR is marked as Ready for Review.

  • Verify that all required changes have been pushed to the repository.

Missing Required Approvals

  • Check the Approval Rules to confirm which groups need to approve the MR.

  • Reach out to the necessary reviewers if approvals are pending.

Merge Conflicts Detected

  • If GitLab reports merge conflicts, request that the author resolves them before proceeding.

  • Use the "Resolve Conflicts" feature in GitLab if you have permissions.

Additional Resources

For more details on Merge Requests: * Creating a Merge Request * PAMMS Training Overview