48 lines
3.3 KiB
Markdown
48 lines
3.3 KiB
Markdown
---
|
|
title: Automatically merging a pull request
|
|
intro: 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.
|
|
product: '{% data reusables.gated-features.auto-merge %}'
|
|
versions:
|
|
free-pro-team: '*'
|
|
enterprise-server: '>=3.1'
|
|
github-ae: '*'
|
|
topics:
|
|
- pull requests
|
|
---
|
|
|
|
### 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](/github/administering-a-repository/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](https://support.github.com/contact/feedback?category=prs-and-code-review&subject=Pull%20request%20auto-merge%20feedback).
|
|
|
|
### 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 %}
|
|
1. In the "Pull Requests" list, click the pull request you'd like to auto-merge.
|
|
1. 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](/github/collaborating-with-issues-and-pull-requests/about-pull-request-merges)."
|
|
|
|
1. Click **Enable auto-merge**.
|
|
|
|
1. 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.
|
|
|
|
1. 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 %}
|
|
1. In the "Pull Requests" list, click the pull request you'd like to disable auto-merge for.
|
|
1. In the merge box, click **Disable auto-merge**.
|
|
|