GitHub ブランチ運用

はじめに

EPKOTで社内開発をする場合のブランチ運用ルールです。
フローについては「GitHub Flow」に「develop」ブランチを追加した形です。

フロー

以下のフローで運用します。
「main」、「develop」には直接コミットしないようにご注意ください。

• Mermaid
  

ブランチ	分岐元	マージ先	コミット	備考
main	-	なし(※)	NG	※ hotfix対応時等で「develop」へ 　マージするケースあり
develop	main	main	NG	PR(Pull request) でマージを行う。
feature/{★任意}	develop	develop	OK	PR(Pull request) でマージを行う。 「main」ブランチへのマージはNG

デフォルトブランチをdevelopに設定する

新規リポジトリを作成した場合、デフォルトブランチをdevelopに設定してください。

• 手順(管理者)
  1. mainブランチからdevelopブランチを作成
  2. GitHubで対象リポジトリのホーム画面を開く
  3. 「Settings」→「Branches」→「Default branch」にdevelopを設定
  4. 再度、GitHubで対象リポジトリのホーム画面を開き、developブランチがデフォルトになっているか確認する。

developブランチを作成する理由

EPKOTではGitHubフリープランを利用しているため
プライベートリポジトリのブランチ保護が出来ません。
mainブランチに誤ってコミットすることを避けるため
デフォルトブランチとしてdevelopを設定しています。