ブランチの名前を変更する

リポジトリにあるブランチの名前を変更できます。

この機能を使用できるユーザーについて

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 Enterprise Server インスタンス上のリポジトリでブランチの名前を変更できます。ブランチの詳細については、「ブランチの概要」を参照してください。

ブランチの名前を変更すると、古いブランチ名を含む URL は、名前を変更されたブランチの同等の URL に自動的にリダイレクトされます。ブランチ保護ポリシー、オープンなプルリクエストのベースブランチ (フォーク含む) およびドラフトリリースも更新されます。名前を変更したブランチが、開いている pull request のヘッドブランチである場合、この pull request は閉じられます。

リポジトリの既定の名前の変更が変更されると、GitHub は、リポジトリのホームページに、コントリビューターにローカルの Git 環境を更新するよう指示が表示されます。

ファイル URL は自動的にリダイレクトされますが、生のファイル URL はリダイレクトされません。また、ユーザーが以前のブランチ名に対して git pull を実行した場合も、GitHub ではリダイレクトされません。

GitHub Actions ワークフローでは名前変更に従わないので、リポジトリでアクションが発行された場合に、@{old-branch-name} を伴うアクションを使用するユーザーは誰でも中断されます。元のコンテンツを含む新しいブランチを追加するとともに、ブランチ名が非推奨であることを報告し、ユーザーに新しいブランチ名への移行を提案するコミットの追加を検討する必要があります。

リポジトリのブランチに適用される組織のルールセットでは、リポジトリ管理者がターゲットリポジトリのブランチの名前を変更したり、既定のブランチを別のブランチに変更したりすることができなくなります。リポジトリ管理者は、適切なアクセス許可を持っている限り、ブランチを作成および削除できます。

ブランチの名前を変更する

GitHub で、リポジトリのメインページに移動します。
ファイルの一覧の上にある [ブランチ] をクリックします。
名前を変更するブランチの横にあるドロップダウンメニューを選択し、 名前の変更ブランチをクリックします。
ブランチの新しい名前を入力します。
ローカル環境についての情報を確認し、 [ブランチの名前変更] をクリックします。

ブランチ名の変更後にローカルクローンを更新する

GitHub Enterprise Server 上のリポジトリにあるブランチ名の変更後、そのリポジトリのローカルクローンのコラボレータは、クローンを更新する必要があります。

コンピュータ上にあるリポジトリのローカルクローンから、以下のコマンドを実行してデフォルトブランチ名を更新します。

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