Viewing Git Commit History with git log

Summary:
Explore Git history with git log and its flags.

When working with Git, understanding the evolution of your project is essential. Whether you’re identifying bugs, reviewing past changes, or collaborating with teammates, viewing the commit history helps you navigate your project’s timeline. The git log command is the primary tool for exploring this history. In this post, we’ll delve into how git log works, explore its most useful flags, and demonstrate how to interpret the information it presents.

What is git log?

At its core, git log displays the commit history of your repository. By default, it lists commits from the most recent to the oldest, showing a wealth of information: commit hashes, authors, dates, and messages. It’s a window into your repository’s story.

$ git log

The output will look something like this:

commit 29a3b1e3e8d7f1f2c3ef7b30bbf5bf0135f1d527
Author: Jane Smith <jane@example.com>
Date:   Tue Jun 25 12:34:56 2024 +0200

    Refactor authentication method for clarity

Each entry corresponds to a unique commit, starting from the most recent.

Customizing Output with Flags

While the default git log provides all the key information, its output can be overwhelming, especially for repositories with a long history. Fortunately, git log is highly configurable through various flags that filter and format its output.

1. Limiting the Number of Commits

To view only a certain number of recent commits, use the -n or --max-count option:

$ git log -5

This shows just the five most recent commits.

2. One-Line Format

For a concise overview, display each commit on a single line:

$ git log --oneline

Example output:

29a3b1e Refactor authentication method for clarity
d1287ed Fix issue with database connection
b6fa831 Add user login endpoint
...

This is especially helpful when you want a quick scan of commit messages.

3. Graphing the Commit History

Visualize branch structure and merges with the --graph flag:

$ git log --oneline --graph --all

Sample output:

* 29a3b1e Refactor authentication method for clarity
| * d1287ed Merge branch 'feature/login'
|/
* b6fa831 Add user login endpoint

The graph uses ASCII art to show branching and merging.

4. Filtering by Author or Date

Focus on commits by a particular contributor using --author:

$ git log --author="Jane"

Or see what’s changed since a certain date:

$ git log --since="2024-06-01"

You can also combine filters:

$ git log --author="Jane" --since="2024-06-01"

5. Inspecting Changes with Patches

Display the file changes introduced in each commit with -p:

$ git log -p

This outputs the diff for each commit—handy for code review or tracking down the origin of a bug.

Formatting Git Log Output

For tailored information, use the --pretty flag with various formats:

  • Short: 
    $ git log --pretty=short
  • Full: 
    $ git log --pretty=full
  • Custom Format: 
    $ git log --pretty=format:"%h - %an, %ar : %s"
    • %h: Abbreviated commit hash
    • %an: Author name
    • %ar: Relative date (e.g. 2 days ago)
    • %s: Commit message

Example output:

29a3b1e - Jane Smith, 4 hours ago : Refactor authentication method for clarity
d1287ed - John Doe, 2 days ago : Fix issue with database connection

Exploring File-Specific History

To see the history of a particular file:

$ git log -- path/to/file.txt

This reveals all commits that touched the specified file, invaluable for tracking when and why changes happened.

Summary Table: Useful git log Flags

Flag Description
--oneline One commit per line (short hash & message)
--graph ASCII graph of branch/merge history
-n <number> or --max-count=<n> Limit number of commits shown
--author="<pattern>" Filter by author
--since="<date>" Show commits since date
--until="<date>" Show commits up to date
-p Show diffs introduced in each commit
--pretty=<format> Custom commit output format
-- path/to/file History of a specific file

Conclusion

The git log command is a powerful ally for developers, offering insight into a project's history and evolution. By mastering its diverse flags and formats, you can locate vital changes, audit your codebase, and collaborate more effectively on any Git project. Explore the options discussed above to make the most out of your commit history tracking!

Further Reading:

Back to All Articles