RAPIDS Docs

This site uses Just the Docs, a documentation theme for Jekyll.

Search

Auto-Merger

Overview

Summary of the automated merge process used for pull requests.

Intended audience

Community

Developers

Summary

Some RAPIDS repositories use an auto-merger to merge pull requests. The auto-merger serves two purposes:

  1. Ensures all merged pull requests have consistent and useful commit messages
  2. Allows pull request merges to be scheduled to occur when all merge criteria (below) are satisfied

To use the auto-merger, simply type /merge as a comment on a given pull request.

There was a secondary use case used when PRs are merged from a release branch back into main.

Sometimes these requests have merge conflicts that need to be resolved and we do NOT want the commits to be squashed.

In order to facilitate this use case the /merge nosquash comment has been implemented.

NOTE The auto-merger will not run if the comment includes any other text besides /merge or /merge nosquash.

If the merge criteria below are satisfied when the comment is left on the pull request, the pull request will merge immediately.

If the merge criteria below are not satisfied when the comment is left on the pull request, the pull request will merge when the criteria become satisfied.

Merge criteria

  • All required (not optional) CI checks must be passing
  • Must not have merge conflicts
  • Branch Checker Ensures the base branch is under active development
  • Label Checker Ensures the correct labels have been applied
  • No changes have been requested from users who have write, admin, or owner permissions
  • Any user who left the /merge comment must have write or admin privileges on the repo

The pull request will be squash merged and the commit title will be formatted like <PR_Title> (#<PR_Number>) . Any square brackets [] in the title will be automatically removed. The commit message will be formatted like (example):

This PR adds some extra line breaks to the commit messages.

Authors:
  - AJ Schmidt (https://github.com/ajschmidt8)

Approvers:
  - Ray Douglass (https://github.com/raydouglass)

URL: https://github.com/rapidsai/cudf/pull/8638/