Gitのブランチ運用を見直した

今までは、サイト構築の初期だったのでブランチを切らずに、コミットした変更はそのままGitHubのmainブランチにプッシュしていた。このサイトもある程度形になってきたので、変更内容をプレビューで確認してから、本番環境へ反映できるよう、Gitのブランチ運用を見直した。

GitHub

まずは、GitHubのリポジトリの Settings > Rules > Rulesets でルールを設定した。

• Require a pull request before merging
• Block force pushes

これで、mainブランチへの直接プッシュができないようになった。

ブランチ

一旦、ブランチは次の命名規則を使用することとした。

プレフィックス	用途	例
feature/	新機能	feature/contact-form
fix/	バグ修正・調整	fix/ipad-layout
journal/	記事執筆	journal/trailing-slash
chore/	雑務	chore/create-docs-git

作業手順

新しい作業を始めるときは、まず最新のmainブランチを取得してから作業ブランチを作成する。

$ git switch main
$ git pull
$ git switch -c プレフィクス/作業内容

ファイルの修正が完了したら、

$ git status
$ git diff
$ git add .
$ git commit -m "変更内容を記録"
$ git push -u origin 作業ブランチ名

-u origin 作業ブランチ名 は、そのブランチを初めてGitHubへプッシュするときだけ指定。2回目以降は、git pushのみ。

プレビューの確認とマージ

次にGitHubへ行き、Compare & pull request をクリック。続いて Create pull request をクリックしてプルリクエスト（PR）を作成すると、Cloudflareからプレビュー画面のURLが記載されたメールが届く。 プレビュー画面で確認して問題がなければマージ（ Squash & Merge ）、そのまま Delete branch をクリックしてGitHub側の作業ブランチを削除。

最後にローカル側の作業ブランチを削除して完了。

$ git switch main
$ git pull
$ git branch -d prefix/branch-name

※ Squash & Merge を使用しているため、ローカルでgit branch -dを実行すると警告が表示されることがあるけど問題ない。

GitHubとCloudflareを連携するだけで、プレビューの運用が簡単に実現できるのはありがたい。