Skip to content

Latest commit

 

History

History
54 lines (40 loc) · 3.68 KB

renaming-a-branch.md

File metadata and controls

54 lines (40 loc) · 3.68 KB
Raw
title intro permissions versions topics redirect_from
Renaming a branch
You can change the name of a branch in a repository.
People with write permissions to a repository can rename a branch in the repository unless it is the [default branch](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-branches#about-the-default-branch) or a [protected branch](/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/about-protected-branches). People with admin permissions can rename the default branch and protected branches.
fpt ghes ghec
*
*
*
Repositories
/github/administering-a-repository/renaming-a-branch
/github/administering-a-repository/managing-branches-in-your-repository/renaming-a-branch

About renaming branches

You can rename a branch in a repository on {% data variables.location.product_location %}. For more information about branches, see "AUTOTITLE)."

When you rename a branch on {% data variables.location.product_location %}, any URLs that contain the old branch name are automatically redirected to the equivalent URL for the renamed branch. Branch protection policies are also updated, as well as the base branch for open pull requests (including those for forks) and draft releases. If the renamed branch is the head branch of an open pull request, this pull request is closed.

If a repository's default branch is renamed, {% data variables.product.prodname_dotcom %} provides instructions on the repository's home page directing contributors to update their local Git environments.

Although file URLs are automatically redirected, raw file URLs are not redirected. Also, {% data variables.product.prodname_dotcom %} does not perform any redirects if users perform a git pull for the previous branch name.

{% data variables.product.prodname_actions %} workflows do not follow renames, so if your repository publishes an action, anyone using that action with @{old-branch-name} will break. You should consider adding a new branch with the original content plus an additional commit reporting that the branch name is deprecated and suggesting that users migrate to the new branch name.

Organizational rulesets that apply to branches of a repository will no longer allow the repository administrator to rename branches of the targeted repository or change the default branch to another branch. Repository administrators may create and delete branches so long as they have the appropriate permissions.

Renaming a branch

{% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.navigate-to-branches %}

  1. Next to the branch you want to rename, select the {% octicon "kebab-horizontal" aria-label="More" %} dropdown menu, then click {% octicon "pencil" aria-label="Rename branch" %} Rename branch.
  2. Type a new name for the branch.
  3. Review the information about local environments, then click Rename branch.

Updating a local clone after a branch name changes

After you rename a branch in a repository on {% data variables.product.product_name %}, any collaborator with a local clone of the repository will need to update the clone.

From the local clone of the repository on a computer, run the following commands to update the name of the default branch.

git branch -m OLD-BRANCH-NAME NEW-BRANCH-NAME
git fetch origin
git branch -u origin/NEW-BRANCH-NAME NEW-BRANCH-NAME
git remote set-head origin -a

Optionally, run the following command to remove tracking references to the old branch name.

git remote prune origin