はじめに

この記事は、GitHubリポジトリのデフォルトブランチを改名する手順を共有するためのものです。

必要となる情報はすべてインターネット上にありますが、分散しているため作業手順を1つの記事にまとめました。

この記事は、以下の環境を前提に書かれています。

GitHubのUIは、2021/11/09時点のものを前提としています。GitHubのバージョンアップによりUIは変わりますのでご注意ください。

この記事では、改名前のブランチ名をmaster、改名後のブランチ名をmainとしています。ブランチ名はお手元の環境に合わせて読み替えてください。また、リモートリポジトリの名前はoriginとします。

改名の手順

git branch -m master main

このコマンドで、ローカルのmasterブランチがmainブランチに改名されます。-mオプションは--moveの短縮表記です。

git push -u origin main

改名したブランチをリモートにpushします。この時点で、リモートには改名前のmasterブランチとmainブランチが共存しています。

Settings→Branches→Default branchの左右矢印ボタンを押すと、デフォルトブランチが切り替わります。

矢印ボタンが表示されない場合は、リモートにmainブランチがpushできていません。再度pushしてください。

git push origin :master

リモートのmasterブランチを削除します。:は本来<ローカルのブランチ名>:<リモートのブランチ名>という書式でブランチ名を指定するものです。今回は<空>:<リモートのmaster>を指定し、リモートのブランチ削除コマンドとして利用しています。

git remote set-head origin --auto

デフォルトブランチが削除されたため、origin/HEADが未指定になります。set-headコマンドでHEADを再指定します。

git checkout master && git pull && git branch -m master main && git push -u origin main && gh browse --settings

ブラウザーでデフォルトブランチを変更してから、リモートのmasterブランチを削除します。

git push origin :master && git remote set-head origin --auto

以上、ありがとうございました。