cd docs
Copy to clipboard

cd docs

Now, before we learn how to delete a local branch, we need tocreateone first in the cloned repository. So, let’s create a branch namedtest1using thegit branchcommand in the terminal:

git branch test1
Copy to clipboard

git branch test1

Next, we can delete the newly createdtest1branch using thegit branch -dcommand. This command is a shorthand for thegit branch --delete:

git branch -d test1
Copy to clipboard

git branch -d test1

Alternatively, we can use the following command:

git branch --delete test1
Copy to clipboard

git branch --delete test1

After we successfully delete the branch, we will receive the following output:

Deleted branch test1
Copy to clipboard

Deleted branch test1

Since there are no commits in thetest1branch that are not in the default (main) branch, the branch is successfully deleted.

However, the operation would have failed if there were unique commits in thetest1branch. In that case, we can force a delete by using thegit branch -Dcommand:

git branch -D test1
Copy to clipboard

git branch -D test1

Potential Errors and Their Solutions

While deleting local branches, there are some potential errors that can occur. Let’s see what they are and how to solve them.

One of the most common errors we can face while we delete a Git branch locally is the ‘Branch not found’ error. This error occurs when the branch name is spelled wrong. So, we need to ensure that we spell the branch name correctly.

To avoid such errors, verify the branch name by listing all branches using the following command:

git branch
Copy to clipboard

git branch

Git doesn’t allow us to delete the branch we’re currently on. We first need to move to another branch and then delete the original branch.

Let’s take thetest1branch, for example. If we’re currently on this branch, we first need to move to another branch (saymain) using thegit switchcommand:

git switch main
Copy to clipboard

git switch main

Then, you can delete thetest1branch:

git branch -d test1
Copy to clipboard

In the next section, we’ll discuss how to delete a branch remotely in Git.

How to Delete a Branch Remotely in Git

Before we look at the process of deleting a remote branch in Git, let’s discuss some common reasons as to why we should be deleting branches remotely.

When to Delete Remote Branches

Scenario 1: If we’ve merged all the changes from a remote branch to the default branch, it indicates that we don’t need that branch anymore, and we can delete it to clean up our repository.

Scenario 2: If we haven’t updated a remote branch for a long time, then we can consider it stale or inactive. In this case, we can delete the branch to keep our repository organized.

Scenario 3: If we no longer need a remote branch because of modifications in the project requirements, then we can delete it to clean up our repository.

Deleting a Branch Remotely in Git

Thegit push -dcommand allows us to delete a remote branch in Git. Here is the syntax for it:

git push remote -d <branch_name>

Here,remoteis the remote repository that contains the branch to be deleted andbranch-nameis the name of the branch itself.

Just like thegit branch -dcommand,git push -dcan be alternatively written as:

git push remote --delete branch

Now, follow the steps mentioned to understand how to delete a remote branch using thegit push -dcommand.

Firstly, fetch all the remote branches that exist on the forkeddocsrepository using thegit fetchcommand:

git fetch origin
Copy to clipboard

git fetch origin

Here,originis an alias that replaces the link to the forkeddocsrepository. Git automatically sets this when we enter the cloned repository for the first time.

Next, check the fetched remote branches using thegit branch -rcommand:

git branch -r
Copy to clipboard

git branch -r

Here is a sample output:

origin/HEAD -> origin/mainorigin/mainorigin/Aireon_Adding_Substringorigin/PyTorch-Tensors-.mean()origin/agraves.test-branchorigin/cppentryorigin/dotnetorigin/full...
Copy to clipboard

origin/HEAD -> origin/mainorigin/mainorigin/Aireon_Adding_Substringorigin/PyTorch-Tensors-.mean()origin/agraves.test-branchorigin/cppentryorigin/dotnetorigin/full...

Now, for instance, if we want to delete thecppentryremote branch, we can use thegit push -dcommand:

git push origin -d cppentry
Copy to clipboard

git push origin -d cppentry

git push origin --delete cppentry
Copy to clipboard

git push origin --delete cppentry

The following output confirms that the remote branch is successfully deleted:

- [deleted]  cppentry
Copy to clipboard

- [deleted]  cppentry

Concept Review and Next Steps

In this article, we explored the commands that allow us to delete a branch locally and remotely in Git, respectively. By understanding these commands, we can eliminate unnecessary branches, keep our repository clean and organized, and improve efficiency.

To learn more about Git, check outHow to Use Git for Beginnerson Codecademy.

'The Codecademy Team, composed of experienced educators and tech experts, is dedicated to making tech skills accessible to all. We empower learners worldwide with expert-reviewed content that develops and enhances the technical skills needed to advance and succeed in their careers.'