重命名分支

本文内容

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

谁可以使用此功能

People with write permissions to a repository can rename a branch in the repository unless it is the default branch or a protected branch. People with admin permissions can rename the default branch and protected branches.

关于重命名分支

可以重命名 GitHub.com 上存储库中的分支。 有关分支的详细信息，请参阅“关于分支”。

当你在 GitHub.com 上重命名分支时，任何包含旧分支名称的网址都会自动重定向到重命名分支的等效 URL。 还更新了分支保护政策以及打开的拉取请求（包括复刻的拉取请求）的基础分支和草稿版本。 如果重命名的分支是打开的拉取请求的头部分支，则关闭此拉取请求。

如果重命名存储库的默认分支，GitHub 在存储库主页上提供说明，指示参与者更新其本地 Git 环境。

虽然文件 URL 会自动重定向，但原始文件 URL 未被重定向。 此外，如果用户对前一个分支名称执行 git pull，则 GitHub 不会执行任何重定向。

GitHub Actions 工作流不遵循重命名，因此，如果存储库发布了一个操作，任何使用 @{old-branch-name} 的操作都将中断。 您应该考虑添加带有原始内容的新分支，外加一个额外的提交报告，说明分支名称已弃用，并建议用户迁移到新的分支名称。

重命名分支

  1. 在 GitHub.com 上，导航到存储库的主页。

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

    存储库的文件树视图的屏幕截图。 分支的下拉菜单已展开，并用深橙色框出。

  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