When you click the default Merge pull request option on a pull request on GitHub.com, all commits from the feature branch are added to the base branch in a merge commit. The pull request is merged using the
To merge pull requests, you must have write permissions in the repository.
When you select the Squash and merge option on a pull request on GitHub.com, the pull request's commits are squashed into a single commit. Instead of seeing all of a contributor's individual commits from a topic branch, the commits are combined into one commit and merged into the default branch. Pull requests with squashed commits are merged using the fast-forward option.
You can use squash and merge to create a more streamlined Git history in your repository. Work-in-progress commits are helpful when working on a feature branch, but they aren’t necessarily important to retain in the Git history. If you squash these commits into one commit while merging to the default branch, you can retain the original changes with a clear Git history.
When you squash and merge, GitHub generates a default commit message, which you can edit. Depending on how the repository is configured and the number of commits in the pull request, not including merge commits, this message may include the pull request title, pull request description, or information about the commits.
|Number of commits||Summary||Description|
|One commit||The title of the commit message for the single commit, followed by the pull request number||The body text of the commit message for the single commit|
|More than one commit||The pull request title, followed by the pull request number||A list of the commit messages for all of the squashed commits, in date order|
People with maintainer or admin access to a repository can configure their repository's default merge message for all squashed commits to use the pull request title, the pull request title and commit details, or the pull request title and description. For more information, see "Configuring commit squashing for pull requests".
If you plan to continue work on the head branch of a pull request after the pull request is merged, we recommend you don't squash and merge the pull request.
When you create a pull request, GitHub identifies the most recent commit that is on both the head branch and the base branch: the common ancestor commit. When you squash and merge the pull request, GitHub creates a commit on the base branch that contains all of the changes you made on the head branch since the common ancestor commit.
Because this commit is only on the base branch and not the head branch, the common ancestor of the two branches remains unchanged. If you continue to work on the head branch, then create a new pull request between the two branches, the pull request will include all of the commits since the common ancestor, including commits that you squashed and merged in the previous pull request. If there are no conflicts, you can safely merge these commits. However, this workflow makes merge conflicts more likely. If you continue to squash and merge pull requests for a long-running head branch, you will have to resolve the same conflicts repeatedly.
When you select the Rebase and merge option on a pull request on GitHub.com, all commits from the topic branch (or head branch) are added onto the base branch individually without a merge commit. In that way, the rebase and merge behavior resembles a fast-forward merge by maintaining a linear project history. However, rebasing achieves this by re-writing the commit history on the base branch with new commits.
The rebase and merge behavior on GitHub deviates slightly from
git rebase. Rebase and merge on GitHub will always update the committer information and create new commit SHAs, whereas
git rebase outside of GitHub does not change the committer information when the rebase happens on top of an ancestor commit. For more information about
git rebase, see git-rebase in the Git documentation.
For a visual representation of
git rebase, see The "Git Branching - Rebasing" chapter from the Pro Git book.
You aren't able to automatically rebase and merge on GitHub.com when:
- The pull request has merge conflicts.
- Rebasing the commits from the base branch into the head branch runs into conflicts.
- Rebasing the commits is considered "unsafe," such as when a rebase is possible without merge conflicts but would produce a different result than a merge would.
If you still want to rebase the commits but can't rebase and merge automatically on GitHub.com you must:
- Rebase the topic branch (or head branch) onto the base branch locally on the command line
- Resolve any merge conflicts on the command line.
- Force-push the rebased commits to the pull request's topic branch (or remote head branch).
Anyone with write permissions in the repository, can then merge the changes using the rebase and merge button on GitHub.com.
A pull request can be merged automatically if its head branch is directly or indirectly merged into the base branch externally. In other words, if the head branch's tip commit becomes reachable from the tip of the target branch. For example:
mainis at commit C.
featurehas been branched off of
mainand is currently at commit D. This branch has a pull request targeting
feature_2is branched off of
featureand is now at commit E. This branch also has a pull request targeting
If pull request E -->
main is merged first, pull request D -->
main will be marked as merged automatically because all of the commits from
feature are now reachable from
main and pushing
main to the server from the command line will mark both pull requests as merged.
Indirect merges can only occur either when the commits in the pull request's head branch are pushed directly to the repository's default branch, or when the commits in the pull request's head branch are present in another pull request and are merged into the repository's default branch using the Create a merge commit option.
If a pull request containing commits present in another pull request's head branch is merged using the Squash and merge or Rebase and merge options, a new commit is created on the base branch and the other pull request will not be automatically merged.
Pull requests that are merged indirectly are marked as
merged even if branch protection rules have not been satisfied.