Automatically merging a pull request

Enable or disable auto-merge for pull requests to streamline your workflow and automatically merge changes once all requirements are met.

Who can use this feature?

Auto-merge for pull requests is available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. See GitHub's plans.

In this article

About auto-merge

Auto-merge merges a pull request automatically after all required reviews and status checks pass. Before you use auto-merge, it must be enabled for the repository. See Managing auto-merge for pull requests in your repository.

Auto-merge is disabled if someone without write permissions pushes new changes to the head branch or switches the base branch.

Enabling auto-merge

Note

The option to enable auto-merge is shown only on pull requests that cannot be merged immediately. For example, when a branch protection rule enforces "Require pull request reviews before merging" or "Require status checks to pass before merging" and these conditions are not yet met. For more information, see Managing a branch protection rule.

People with write permissions to a repository can enable auto-merge for a pull request.

  1. On GitHub, navigate to the main page of the repository.

  2. Under your repository name, click Pull requests.

  3. In the "Pull Requests" list, click the pull request you want to auto-merge.

  4. Optionally, select the dropdown menu, then click a merge method. See Pull request merges.

    Screenshot of the merge box of a pull request. A dropdown menu, labeled with a downward-facing triangle, is outlined in dark orange.

  5. Click Enable auto-merge.

  6. If you chose the merge or squash and merge methods, type a commit message and description and choose the email address you want to author the merge commit.

    Note

    The email dropdown menu is not available if you have email privacy enabled or if you only have one verified and visible email associated with your GitHub account.

  7. Click Confirm auto-merge.

Disabling auto-merge

People with write permissions to a repository and pull request authors can disable auto-merge for a pull request.

  1. On GitHub, navigate to the main page of the repository.
  2. Under your repository name, click Pull requests.
  3. In the "Pull Requests" list, click the pull request for which you want to disable auto-merge.
  4. In the merge box, click Disable auto-merge.