[git] ブランチ名を変更する(master -> main)

Tech

※ 本記事はアフィリエイト広告(Amazonアソシエイト)を含みます。

[git] ブランチ名を変更する(master -> main)

GitHub の新規リポジトリが main 始まりになってから、手元の古いリポジトリだけ master のまま、という状態がしばらく続いていました。混在していると地味にコマンドを打ち間違えるので、main に揃えたときの手順です。

ローカルのブランチ名を変える

git branch -m master main

-m は move(リネーム)。今いるブランチを変えるなら git branch -m main だけでもOKです。

リモートに反映する

ローカルを変えただけでは、リモートは master のまま。新しい名前で push して、追跡先も設定します。

git push -u origin main

GitHub のデフォルトブランチを切り替える

ここを忘れがち。リポジトリの Settings → General → Default branch で main に切り替えます。

ℹ️ GitHub の画面上でブランチ名を変更(Branches 一覧の鉛筆アイコン)する方法もあります。この場合はオープン中のPRの向き先なども自動で付け替えてくれるので、リモート側の変更は Web UI でやるのが一番ラクです。

古い master を消す

デフォルトブランチを切り替えたあとなら、リモートの master を削除できます。

git push origin --delete master

他の環境(別PC・チームメンバー)で追従する

すでに clone 済みの環境では、こう追いかけます。

git branch -m master main
git fetch origin
git branch -u origin/main main
git remote set-head origin -a

最後の set-head は、origin/HEAD の向き先を新しいデフォルトブランチに合わせるためのもの。GitHub でブランチ名を変えると、ほぼ同じコマンドが画面に案内されます。

そもそも新規リポジトリを main で始める

git init したときの初期ブランチ名は設定で変えられます(Git 2.28 以降)。

git config --global init.defaultBranch main

一度入れておけば、ローカルで作ったリポジトリが master になることはもうありません。

ハマりどころ・メモ

  • CI/CD の設定に master が直書きされている: GitHub Actions の on: push: branches: [master] や、デプロイ先の「本番ブランチ」設定。このブログも Cloudflare Pages の本番ブランチ設定が main 前提です
  • デフォルトブランチを切り替える前に master を消そうとすると拒否されます。切り替え → 削除の順番
  • 他の人が作業中のブランチがある場合は、事前にひと声かけておくのがマナー

まとめ

手順コマンド / 操作
ローカルをリネームgit branch -m master main
リモートに pushgit push -u origin main
デフォルトブランチ変更GitHub の Settings → General
旧ブランチ削除git push origin --delete master
今後の新規リポジトリgit config --global init.defaultBranch main

一度揃えてしまえば、もう迷うことはありません。

git