How to perform a Git clean up of branches and commits example

How to Perform a Git Cleanup of Branches and Commits

Managing branches and commits efficiently in Git is essential for maintaining a clean and organized codebase. Over time, unused branches and unstructured commits can clutter your repository. This guide will show you how to clean up local and remote branches and organize your commits.

. Cleaning Up Local Branches

Unused local branches can pile up quickly. Follow these steps to clean them up:

Step 1: List Local Branches

Run the following command to view all your local branches:

git branch

Step 2: Delete a Local Branch

Delete branches that you no longer need using:

git branch -d branch_name

If the branch has unmerged changes, use:

git branch -D branch_name

⚠️ Be cautious with -D as it forcefully deletes the branch.

Step 3: Automate Stale Branch Cleanup

You can identify and delete branches merged into main (or master) with:

git branch --merged main | grep -v '\*' | xargs -n 1 git branch -d

This deletes branches already merged into the main branch.

2. Cleaning Up Remote Branches

Unused remote branches can also accumulate, especially in collaborative projects.

Step 1: List Remote Branches

View remote branches using:

git branch -r

Step 2: Delete a Remote Branch

To delete a branch from the remote repository:

git push origin --delete branch_name

Step 3: Prune Deleted Remote Branches Locally

Sync your local branch references with the remote repository:

git fetch --prune

3. Cleaning Up Commits

Commits can also be messy if they contain incomplete or unrelated changes. Here's how to tidy them up:

Step 1: Combine Commits Using Rebase

You can squash multiple commits into one:

git rebase -i HEAD~n

Replace n with the number of recent commits to review. Mark commits as squash or fixup to combine them.

Step 2: Edit Commit Messages

During an interactive rebase, you can update commit messages for clarity.

Step 3: Remove Unwanted Commits

You can drop a commit during the interactive rebase process if it is unnecessary.

4. General Tips for Git Cleanup

• Use Tags for Milestones: Before deleting branches, tag key commits:

  git tag -a v1.0 -m "Version 1.0"
  

• Backup Before Cleanup: Create a backup branch if you're unsure:

  git checkout branch_name
  git checkout -b backup_branch_name
  

• Document Branch Conventions: Establish clear naming conventions to avoid unnecessary branches.

5. Automation Tools

• Git Extensions: Tools like git-extras can automate branch cleanup.
• Alias Commands: Add aliases to your .gitconfig for common tasks:

  [alias]
    clean-branches = "!git branch --merged | grep -v '\\*' | xargs -n 1 git branch -d"
  

Regularly cleaning up your branches and commits ensures your repository remains efficient and easy to navigate. Start practicing these tips today to keep your Git workflow organized!