How to Compare Two Branches in Git?

Git is an essential tool for developers, enabling version control and collaboration on projects. One of its powerful features is the ability to compare branches, which allows you to review differences between two versions of your codebase. Whether you’re inspecting changes before merging, debugging, or tracking feature development, comparing branches is a critical skill.

This blog explains how to compare two branches in Git, covering various approaches, commands, and best practices.

Why Compare Two Branches in Git?

Comparing branches helps you:

1. Review Changes: Analyze what’s been added, modified, or removed in one branch compared to another.
2. Prepare for Merging: Check for conflicts or unintended changes before merging branches.
3. Debug Issues: Identify where bugs or regressions were introduced.
4. Collaborate Effectively: Share insights with teammates about the differences between branches.

---

Methods to Compare Two Branches in Git

There are several ways to compare branches in Git, each serving different purposes. Below are some common methods.

---

1. Using git diff

The git diff command is the most direct way to compare branches. It shows line-by-line differences between two branches.

Command Syntax:

git diff branch1 branch2

Example:

To compare the feature branch with main:

git diff main feature

This will display all the differences between the two branches in terms of added, modified, and deleted lines.

---

2. Comparing Branches for Specific Files

If you’re interested in changes to a particular file, you can specify the file path with git diff.

Command Syntax:

git diff branch1 branch2 -- file-path

Example:

To compare the README.md file in feature and main branches:

git diff main feature -- README.md

---

3. Comparing Commit Histories with git log

The git log command lets you compare the commit history of two branches, helping you identify unique commits in each branch.

Command Syntax:

git log branch1..branch2

Example:

To see commits in feature that are not in main:

git log main..feature

For a two-way comparison (commits unique to either branch), use:

git log main...feature

---

4. Using git diff --name-only to List Affected Files

If you want a list of files that differ between two branches, use the --name-only flag with git diff.

Command Syntax:

git diff --name-only branch1 branch2

Example:

git diff --name-only main feature

Output:

file1.txt
file2.js
README.md

This output lists all the files that have been changed.

---

5. Graphical Comparison with git log --graph

For a visual representation of branch histories and divergence points, use the --graph option with git log.

Command Syntax:

git log --oneline --graph --all

Example:

git log --oneline --graph main feature

This displays a commit graph showing how the branches diverged and where they merge.

---

6. Using Git Merge Base for Common Ancestor Comparison

Sometimes you want to compare a branch with their common ancestor to understand the total scope of changes.

Find the Common Ancestor:

git merge-base branch1 branch2

Compare Branch with the Common Ancestor:

git diff branch1 $(git merge-base branch1 branch2)

This highlights differences between the branch and their shared starting point.

---

7. Using Tools Like gitk or Third-Party GUIs

For users who prefer graphical interfaces, tools like gitk, SourceTree, or GitHub Desktop provide visual diff and merge views.

Using gitk:

gitk branch1 branch2

This opens a GUI showing commit histories and file changes.

---

Best Practices for Comparing Branches

1. Run Comparisons Regularly: Regular comparisons help identify issues early, especially in large, collaborative projects.
2. Use Descriptive Branch Names: Clear branch names make it easier to identify and compare their purposes.
3. Check Before Merging: Always review changes and test for conflicts before merging branches.
4. Leverage Aliases: Create Git aliases for commonly used comparison commands to save time.

---

Real-World Example: Comparing and Merging Branches

Scenario:

You have a feature branch and a main branch. You want to:

1. Review changes in feature.
2. Check for potential merge conflicts.
3. Merge the feature branch into main.

Steps:

1. Compare Changes:

   git diff main feature

2. Check Commit History:

   git log main..feature

3. Identify Affected Files:

   git diff --name-only main feature

4. Merge and Resolve Conflicts (if any):

   git checkout main
   git merge feature

If conflicts arise, Git will highlight them for manual resolution.

---

Conclusion

Comparing branches in Git is a vital skill for developers, enabling better understanding and control over code changes. By using commands like git diff and git log, or graphical tools like gitk, you can efficiently analyze differences and prepare for merges. Regular branch comparisons help maintain a clean and organized codebase, especially in collaborative environments.

With the techniques outlined in this guide, you can confidently manage branch comparisons and streamline your Git workflow.