跳至主要内容

重命名分支

您可以更改仓库中的分支名称。

谁可以使用此功能?

拥有仓库写入权限的人员可以重命名仓库中的分支,除非它是默认分支受保护分支。拥有管理员权限的人员可以重命名默认分支和受保护分支。

关于重命名分支

您可以在 GitHub.com 上重命名仓库中的分支。有关分支的更多信息,请参阅“关于分支”。

重命名分支后,包含旧分支名称的任何 URL 将自动重定向到重命名分支的等效 URL。分支保护策略也会更新,以及打开的拉取请求(包括分叉的拉取请求)和草稿发布的基础分支。如果重命名的分支是打开的拉取请求的头部分支,则此拉取请求将关闭。

如果仓库的默认分支已重命名,GitHub 会在仓库的主页上提供说明,指导贡献者更新其本地 Git 环境。

尽管文件 URL 会自动重定向,但原始文件 URL 不会重定向。此外,如果用户对以前的分支名称执行 git pull,GitHub 不会执行任何重定向。

GitHub Actions 工作流不遵循重命名,因此,如果您的仓库发布了操作,任何使用 @{old-branch-name} 的人都将中断。您应该考虑添加一个新分支,其中包含原始内容加上一个额外的提交,报告分支名称即将关闭,并建议用户迁移到新的分支名称。

应用于仓库分支的组织规则集将不再允许仓库管理员重命名目标仓库的分支或将默认分支更改为另一个分支。只要拥有相应的权限,仓库管理员就可以创建和删除分支。

重命名分支

  1. 在 GitHub 上,导航到仓库的主页。

  2. 从左侧的文件树视图中,选择分支下拉菜单,然后单击**查看所有分支**。您也可以在集成文件编辑器的顶部找到分支下拉菜单。

    Screenshot of the file tree view for a repository. A dropdown menu for branches is expanded and outlined in dark orange.

  3. 在要重命名的分支旁边,选择下拉菜单,然后单击 重命名分支.

  4. 为分支键入新名称。

  5. 查看有关本地环境的信息,然后单击**重命名分支**。

分支名称更改后更新本地克隆

在 GitHub 上重命名仓库中的分支后,任何拥有仓库本地克隆的协作者都需要更新克隆。

从计算机上的仓库本地克隆中,运行以下命令以更新默认分支的名称。

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

可选:运行以下命令以删除对旧分支名称的跟踪引用。

git remote prune origin