3.3 KiB
title, intro, product, versions, topics
| title | intro | product | versions | topics | |||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| 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. | {% data reusables.gated-features.auto-merge %} |
|
|
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."{% if currentVersion == "free-pro-team@latest" or currentVersion == "github-ae@next" or currentVersion ver_gt "enterprise-server@3.1" %}
After you enable auto-merge for a pull request, if someone who does not have write permissions to the repository pushes new changes to the head branch or switches the base branch of the pull request, auto-merge will be disabled. For example, if a maintainer enables auto-merge for a pull request from a fork, auto-merge will be disabled after a contributor pushes new changes to the pull request.{% endif %}
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.
{% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-pr %}
- In the "Pull Requests" list, click the pull request you'd like to auto-merge.
- 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."
- Click Enable auto-merge.
- 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.
- 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.
{% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-pr %}
- In the "Pull Requests" list, click the pull request you'd like to disable auto-merge for.
- In the merge box, click Disable auto-merge.
