1
0
mirror of synced 2025-12-21 02:46:50 -05:00
Files
docs/content/github/collaborating-with-issues-and-pull-requests/automatically-merging-a-pull-request.md
Laura Coursen d20831c23f Auto-merge (#16761)
* Add new article

* Mention auto-merge in related articles

* Add new article

* Make intro inclusive

* Add content for repo setting

* Add versioning to reusable

* Add procedures

* Add gated features callout

* Add permissions statements

* Add conceptual content

* Fix filename

* Add missing step

* Fix syntax

* Add 💅

* Update permissions

* Add 💅

* Add missing period

* Add 💅

* Add 💅

* Add auto-merge to permissions articles

* Fix permissions

* Add 💅

* Let @mattpollard fix everything and take partial credit

Co-authored-by: Matt Pollard <mattpollard@users.noreply.github.com>

* Incorporate answers to questions

* Add how to provide feedback

* Update feedback link

Co-authored-by: Matt Pollard <mattpollard@users.noreply.github.com>
Co-authored-by: Melanie Yarbrough <11952755+myarb@users.noreply.github.com>
2020-12-15 21:41:17 +00:00

2.8 KiB

title, intro, product, versions
title intro product versions
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 %}
free-pro-team
*

{% data reusables.pull_requests.auto-merge-release-phase %}

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.

{% 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.
  2. 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
  3. Click Enable auto-merge. Button to enable auto-merge
  4. 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
  5. 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.

{% 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.
  2. In the merge box, click Disable auto-merge. Button to disable auto-merge