Bisect for finding bug-introducing commits in Git - Commands & Configuration

Introduction

Sometimes a bug appears in your project, but you don't know which change caused it. Git bisect helps you find the exact commit that introduced the bug by testing commits step-by-step.

When a bug suddenly appears and you want to find which code change caused it.

When you have many commits and manually checking each one is too slow.

When you want to save time by automatically narrowing down the bad commit.

When you want to confirm if a specific commit fixed or caused a problem.

When you want to share the exact bad commit with your team for faster fixes.

Commands

This command starts the bisect process. It tells Git you want to find a bad commit.

Terminal

git bisect start

Expected Output

No output (command runs silently)

Marks the current commit as bad, meaning it has the bug.

Terminal

git bisect bad

Expected Output

Bisecting: 4 revisions left to test after this (roughly 2 steps)

Marks the commit tagged 'v1.0' as good, meaning it does not have the bug. This helps Git narrow down the search.

Terminal

git bisect good v1.0

Expected Output

Bisecting: 2 revisions left to test after this (roughly 1 step)

Runs an automated test script on each commit Git checks during bisect. It marks commits good or bad based on the script's exit code.

Terminal

git bisect run ./test_script.sh

Expected Output

Bisecting: 1 revision left to test after this (roughly 0 steps)

<commit-hash> is the first bad commit

Ends the bisect session and returns you to the original branch and commit.

Terminal

git bisect reset

Expected Output

Bisect reset to the original HEAD

Key Concept

If you remember nothing else from this pattern, remember: git bisect helps you quickly find the exact commit that introduced a bug by marking known good and bad commits and testing in between.

Common Mistakes

Not marking a known good commit before starting bisect

Git needs a known good commit to compare against the bad commit to narrow down the search.

Always mark a known good commit with 'git bisect good <commit>' after starting bisect.

Forgetting to run 'git bisect reset' after finishing

You remain in bisect mode, which can confuse further work and leave your repo in a detached HEAD state.

Run 'git bisect reset' to return to your original branch and clean up.

Using 'git bisect bad' on a commit that is actually good

This misleads Git and can cause it to find the wrong commit or fail to find the bug.

Carefully test the commit before marking it bad to ensure it really has the bug.

Summary

Start bisect with 'git bisect start' to begin finding the bad commit.

Mark a known bad commit with 'git bisect bad' and a known good commit with 'git bisect good <commit>'.

Use 'git bisect run <script>' to automate testing or manually mark commits good or bad.

Finish with 'git bisect reset' to return to your original branch.

Practice

1. What is the main purpose of git bisect?

easy

A. To delete old commits from history

B. To merge two branches automatically

C. To create a new branch from the current commit

D. To find the first commit that introduced a bug

Solution

1. Step 1: Understand the role of git bisect

   Git bisect helps identify which commit introduced a bug by testing commits between a known good and a bad commit.

2. Step 2: Compare with other git commands

   Merging branches, deleting commits, or creating branches are different git operations unrelated to bisect.

3. Final Answer:

   To find the first commit that introduced a bug -> Option D

4. Quick Check:

   git bisect = find bug commit [OK]

Hint: Bisect narrows down bug commit by testing between good and bad [OK]

Common Mistakes:

• Confusing bisect with merge or branch commands
• Thinking bisect deletes commits
• Assuming bisect creates branches

2. Which command correctly starts a bisect session assuming HEAD is bad and v1.0 is good?

easy

A. git bisect start v1.0 HEAD

B. git bisect start HEAD v1.0

C. git bisect begin HEAD v1.0

D. git bisect init v1.0 HEAD

Solution

1. Step 1: Recall git bisect start syntax

   The correct syntax is git bisect start <bad> <good>, where the first argument is the bad commit and the second is the good commit.

2. Step 2: Match the given commits

   Since HEAD is bad and v1.0 is good, the command is git bisect start HEAD v1.0.

3. Final Answer:

   git bisect start HEAD v1.0 -> Option B

4. Quick Check:

   git bisect start bad good = start [OK]

Hint: Start bisect with bad commit first, then good commit [OK]

Common Mistakes:

• Reversing good and bad commits in the command
• Using incorrect command like bisect begin or init
• Omitting the start keyword

3. Given this bisect session output:

Bisecting: 3 revisions left to test after this (roughly 2 steps)
Testing commit abc1234

If you run git bisect good and then git bisect bad on the next commit, what will git do next?

medium

A. Git will narrow down the range and checkout the next commit to test

B. Git will end the bisect session immediately

C. Git will reset to the original branch without changes

D. Git will throw an error because you cannot mark good then bad consecutively

Solution

1. Step 1: Understand bisect workflow

   Marking commits as good or bad tells git which side of the commit range to keep searching. After marking, git checks out the next commit to test.

2. Step 2: Analyze the given commands

   Marking one commit good, then the next bad, narrows the search range. Git continues bisecting until it finds the first bad commit.

3. Final Answer:

   Git will narrow down the range and checkout the next commit to test -> Option A

4. Quick Check:

   Mark good/bad -> git picks next commit [OK]

Hint: Mark commits good/bad to let git pick next test commit [OK]

Common Mistakes:

• Thinking bisect ends after one good and one bad mark
• Assuming git resets automatically after marking
• Believing marking good then bad consecutively causes error

4. You started a bisect session but accidentally marked a good commit as bad. What is the best way to fix this?

medium

A. Edit the .git/BISECT_LOG file manually to fix the mistake

B. Run git bisect skip on the wrong commit

C. Run git bisect good on the same commit to correct it

D. Run git bisect reset and start over

Solution

1. Step 1: Understand bisect marking correction

   Git bisect allows re-marking a commit to correct its status if marked incorrectly.

2. Step 2: Correct the marking

   Run git bisect good on the commit you accidentally marked as bad to update the bisect state.

3. Final Answer:

   Run git bisect good on the same commit to correct it -> Option C

4. Quick Check:

   Re-mark good/bad to correct [OK]

Hint: Re-mark the commit with git bisect good to fix [OK]

Common Mistakes:

• Thinking you must reset instead of re-marking
• Editing internal git files manually
• Using skip to fix a marking error

5. You have a large project with 1000 commits. You know commit abc123 is good and def456 is bad. You want to find the first bad commit using git bisect. Which sequence of commands correctly performs this task?

hard

A. git bisect start def456 abc123; git bisect bad def456; git bisect good abc123; test commits; git bisect reset

B. git bisect start abc123 def456; git bisect bad abc123; git bisect good def456; test commits; git bisect reset

C. git bisect start def456 abc123; git bisect good def456; git bisect bad abc123; test commits; git bisect reset

D. git bisect start abc123 def456; git bisect good def456; git bisect bad abc123; test commits; git bisect reset

Solution

1. Step 1: Start bisect with bad then good commit

   The correct syntax is git bisect start <bad> <good>. Since def456 is bad and abc123 is good, the command is git bisect start def456 abc123.

2. Step 2: Mark the known commits correctly

   Mark the bad commit with git bisect bad def456 and the good commit with git bisect good abc123. Then test intermediate commits as git suggests.

3. Step 3: Finish bisect session

   After finding the first bad commit, run git bisect reset to return to the original branch.

4. Final Answer:

   git bisect start def456 abc123; git bisect bad def456; git bisect good abc123; test commits; git bisect reset -> Option A

5. Quick Check:

   Start with bad then good, mark correctly, reset [OK]

Hint: Start bisect with bad then good commit, mark accordingly [OK]

Common Mistakes:

• Reversing good and bad commits in start command
• Marking commits with wrong status
• Skipping reset after bisect finishes