GitHub AE is currently under limited release. Please contact our Sales Team to find out more.

Automatically merging a pull request

You can increase development velocity by enabling auto-merge for a pull request so that the pull request will merge automatically when all merge requirements are met.

Auto-merge for pull requests is available in internal and private repositories with GitHub AE, 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.

In this article

About auto-merge

If you enable auto-merge for a pull request, the pull request will merge automatically when all required reviews are met and status checks have passed. Auto-merge prevents you from waiting around for requirements to be met, so you can move on to other tasks.

Before you can use auto-merge with a pull request, auto-merge must be enabled for the repository. For more information, see "Managing auto-merge for pull requests in your repository."

You can provide feedback about auto-merge by contacting us.

Enabling auto-merge

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

  1. On GitHub AE, navigate to the main page of the repository.
  2. Under your repository name, click Pull requests. Issues and pull requests tab selection
  3. In the "Pull Requests" list, click the pull request you'd like to auto-merge.
  4. Optionally, to choose a merge method, select the Enable auto-merge drop-down menu, then click a merge method. For more information, see "About pull request merges." "Enable auto-merge" drop-down menu
  5. Click Enable auto-merge. Button to 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. Fields to enter commit message and description and choose commit author email
  7. Click Confirm auto-merge. Button to 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 AE, navigate to the main page of the repository.
  2. Under your repository name, click Pull requests. Issues and pull requests tab selection
  3. In the "Pull Requests" list, click the pull request you'd like to disable auto-merge for.
  4. In the merge box, click Disable auto-merge. Button to disable auto-merge

Did this doc help you?

Privacy policy

Help us make these docs great!

All GitHub docs are open source. See something that's wrong or unclear? Submit a pull request.

Make a contribution

Or, learn how to contribute.