How to Change the Branch Name in Git?

In Git, branch names often reflect the purpose or feature being developed. Sometimes, you may want to rename a branch to improve clarity, conform to naming conventions, or simply correct a typo. This post will walk you through renaming a Git branch locally and remotely, whether you’re working on main, development, or any other branch.

Why Change a Branch Name?

Renaming branches can be helpful for:

• Improving clarity by following a naming convention (e.g., feature/feature-name, bugfix/bug-name).
• Updating from master to main or other standard names for inclusive language.
• Correcting errors or typos in the branch name.

Changing a branch name in Git is a simple process but requires careful attention when pushing changes to a remote repository.

---

Prerequisites

Before proceeding, make sure you:

1. Have Git Installed: Git must be installed on your system. Download Git here if you haven’t already.
2. Have a Clean Working Directory: Ensure that there are no uncommitted changes in the branch you’re renaming.

---

Step 1: Rename the Branch Locally

Git provides a straightforward command to rename a branch locally. Follow these steps:

1. Check Out the Branch You Want to Rename

• You can only rename the branch you’re currently on. Switch to it using:
  bash git checkout old-branch-name
• Replace old-branch-name with the name of the branch you wish to rename.

1. Rename the Branch Locally

• Use the following command to rename your branch:
  bash git branch -m new-branch-name
• Replace new-branch-name with the desired branch name. The -m option stands for “move” and renames the branch in place.

1. Verify the Renaming

• To ensure the branch name has changed, list all branches:
  bash git branch
• The output should reflect the new branch name.

Step 2: Update the Remote Repository (if applicable)

If you have already pushed your branch to a remote repository, you’ll need to update it with the new branch name. Here’s how:

1. Delete the Old Branch Name on the Remote

• To remove the old branch name from the remote repository, use:
  bash git push origin --delete old-branch-name
• This step only deletes the branch reference on the remote server but does not remove any commits.

1. Push the New Branch Name to the Remote

• Now, push the branch with the new name:
  bash git push -u origin new-branch-name
• The -u option sets origin new-branch-name as the default for future push and pull commands, which is helpful for branch tracking.

1. Update Branch Tracking (Optional)

• If the branch was previously tracking the remote branch with the old name, updating the tracking information helps Git keep the branches in sync:
  bash git branch --unset-upstream git push -u origin new-branch-name
• These commands first remove any upstream tracking for the old branch and then set it up with the new branch name.

---

Changing the Default Branch in GitHub, GitLab, or Bitbucket

If you renamed a branch that is set as the default branch (e.g., main), you may need to update the default branch setting on your Git hosting platform. Here’s how to change the default branch in popular Git platforms:

GitHub

1. Go to Repository Settings:

• In GitHub, navigate to Settings > Branches.

1. Change Default Branch:

• Under Default branch, select your new branch name from the dropdown list.

1. Update Pull Requests and Branch Protections:

• GitHub will notify you of any pull requests or branch protection rules that are affected. Make sure to review these updates.

GitLab

1. Go to Repository Settings:

• In GitLab, go to Settings > Repository > Default branch.

1. Change Default Branch:

• Select your new branch name and save the changes.

Bitbucket

1. Navigate to Branch Settings:

• Go to Repository settings > Branches.

1. Update Default Branch:

• Choose your new branch from the dropdown and save the setting.

Changing the default branch in your Git hosting platform prevents conflicts for collaborators and ensures consistency across your development workflow.

---

Summary of Commands

Here’s a quick overview of the commands covered:

Action	Command
Switch to Branch	git checkout old-branch-name
Rename Branch Locally	git branch -m new-branch-name
Delete Old Branch on Remote	git push origin --delete old-branch-name
Push New Branch to Remote	git push -u origin new-branch-name
Unset Upstream Tracking (Optional)	git branch --unset-upstream
Set Upstream Tracking	git push -u origin new-branch-name

---

Best Practices for Renaming Branches

1. Communicate with Your Team: If you’re working in a collaborative environment, inform team members about the branch name change to avoid confusion.
2. Avoid Frequent Renaming: Changing branch names too often can complicate workflows, especially if they’re already in use for pull requests or deployments.
3. Update Branch Protection Rules: If your repository uses branch protection rules (e.g., for main or develop branches), ensure these rules apply to the renamed branch to maintain the same level of protection.
4. Notify CI/CD Systems: If your CI/CD system references the branch by name, update the configuration to reflect the new branch name.

---

Conclusion

Renaming a branch in Git is a simple yet valuable skill, allowing you to keep your branches organized, consistent, and meaningful. Whether you’re renaming a branch locally or updating the branch name on a remote repository, these steps ensure a smooth transition with minimal impact on your workflow.

By following best practices and updating any associated configurations, you can manage branch renaming seamlessly, making your version control cleaner and more effective.