Keywords: Git | commit squashing | interactive rebase
Abstract: This paper provides an in-depth analysis of techniques for squashing multiple commits into a single commit in the Git version control system. By examining the core mechanisms of interactive rebasing, it details how to use the git rebase -i command with squash options to achieve commit consolidation. The article covers the complete workflow from basic command operations to advanced parameter usage, including specifying commit ranges, editing commit messages, and handling force pushes. Additionally, it contrasts manual commit squashing with GitHub's "Squash and merge" feature, offering practical advice for developers in various scenarios.
In collaborative development environments, maintaining a clean commit history is crucial for the maintainability of codebases. When developers submit pull requests to remote repositories, maintainers often request squashing multiple related commits into a single commit to simplify history and improve readability. This paper systematically introduces technical methods to achieve this goal, focusing on the core principles and practical techniques of interactive rebasing.
Fundamentals of Interactive Rebasing
Git's rebase -i command initiates interactive rebase mode, allowing developers to reorder, edit, or combine commits. When executing git rebase -i HEAD~3, Git opens a text editor displaying a list of the last three commits. Each commit is prefixed with a command identifier, defaulting to pick, indicating the commit remains unchanged. By modifying these identifiers, developers control commit behavior during the rebase process.
Step-by-Step Commit Squashing Procedure
To squash commits, first determine the commit range. Use the git rebase -i HEAD~N command, where N represents the number of commits to include. In the opened editor, keep the first commit as pick and change all subsequent commit identifiers to squash or s. After saving and closing the editor, Git initiates a second editor session for editing the combined commit message. Here, developers can write a clear, descriptive commit message summarizing changes from all squashed commits.
Commit Hashes and Range Specification
Beyond relative references like HEAD~3, developers can precisely specify rebase ranges using commit hashes. For example, git rebase -i a1b2c3d rebases from the current commit back to the commit with hash a1b2c3d. This method is particularly useful for handling non-consecutive commits or specific branch points. In the editor, similarly mark subsequent commits as squash to achieve compression.
Force Pushing and Remote Synchronization
After completing local commit squashing, since history has been rewritten, force pushing is necessary to synchronize changes to the remote repository. Execute git push --force origin branch-name, where branch-name is the target branch name. Note that force pushing overwrites remote branch history, so it should be used cautiously in collaborative environments, ensuring all collaborators are aware of the change.
GitHub's Integrated Feature
Since April 2016, GitHub has offered a "Squash and merge" feature, allowing repository maintainers to squash commits directly in the pull request interface. When this option is selected, GitHub automatically squashes all commits into a single commit using preset or custom commit messages. This feature simplifies collaboration but developers should still understand manual squashing techniques for fine-grained control when needed.
Practical Recommendations and Considerations
Before squashing commits, it is advisable to create branch backups or use git reflog to record original commit history in case of errors. Additionally, commit squashing is best suited for organizing local development history or cleaning up feature branches. For already shared commits, avoid rewriting history to prevent disrupting other collaborators' work. By mastering these techniques, developers can manage commit history more effectively, enhancing team collaboration efficiency.