メインコンテンツへスキップ
見出し画像

GitHubを本番規模で使う設計図~保護ブランチからホットフィックスまでを一本の線で読む~

    最近、Kushal Gangilさん(@techyoutbe)の「GitHub at Production Scale (A 6-Slide Visual Guide)」を読みました。

    一人で使うGitHubと、複数人が本番へコードを出すGitHubは、別のものです。各段階を別々の作法として並べず、「速く出しても雑にしない」という一つの目的でつないでいる点が面白いです。

    この記事では、6枚の図が描く流れを手始めに、各段階が何を守っているのかを整理します。

    【発端】 本番運用の流れを描く一本の線

    画像
    起点の6枚の図は、本番運用を七つの段階の一本線で描いている

    リポジトリの準備から障害対応までは、前の段階の結果が次の段階の出発点になる一続きの流れです。

    原文は、全体を次の線で表しています。リポジトリ、ブランチ、プルリクエスト(PR)、マージ、リリース、ホットフィックス、ベストプラクティスの順です。

    ホットフィックスは、本番障害に対する緊急の修正のことです。

    【基礎】 人が忘れる作業という守る対象

    本番運用のGitHubでは、人の注意力に頼る部分を仕組みへ移します。

    原文の言葉を借りると、人が忘れがちな作業は自動化します。出発点は、mainブランチへ直接プッシュしない運用です。

    変更はPRを経由させ、レビューと自動チェックを通してから取り込みます。

    この運用を支える機能は主に三つあります。

    • 保護ブランチ:既定では強制プッシュと削除を禁じ、設定で許可できます。マージ条件の例は必須のステータスチェックで、説明はGitHub Docsにあります。

    • CODEOWNERS:パスごとの担当者やチームを書いたファイルです。.github/、リポジトリ直下、docs/のいずれかに置きます。PRの対象ブランチに置かれていることが、レビュー依頼が届く条件です。GitHub Docsで確認できます。

    • PR・Issueテンプレート:変更理由や確認項目を、書き忘れない形に固定します。

    必須ステータスチェックは、指定した検査が成功、スキップ、中立のいずれかになるまでマージを止めます。さらに「ベースブランチに追いついていること」を求める厳格な設定もあります。

    ルールを人の記憶ではなくGitHubの側に置くことが大事です。「レビューを忘れた」という失敗が、構造上起こりにくくなります。

    【違い】 人数ではなくリリース頻度で選ぶブランチ戦略

    画像
    「いつ、どんな単位で利用者に届くか」が、戦略を決める軸になる

    原文の判断軸は、チーム人数ではなくリリースの頻度です。

    人数が多いから複雑な戦略が要る、という見方はしません。1日に何度も出すなら、短命ブランチをこまめにマージするトランクベース開発が候補になります。

    トランクベース開発は、main(トランク)へ小さな変更を頻繁に統合する手法です。

    リリース間の分離が必要なら、main・develop・release・hotfixを使うGit Flowが候補です。

    向く場面

    • トランクベース:頻繁なリリース

    • Git Flow:計画されたリリース、より強い分離

    ブランチの寿命

    • トランクベース:短い(2日を超えない)

    • Git Flow:機能は開発中ずっと。releaseとhotfixは用途ごと

    本番へ出す形

    • トランクベース:小さな変更を継続的に出す

    • Git Flow:リリースブランチで整えてから出す

    Trunk Based Developmentは、短命ブランチは2日を超えない、と書いています。2日を超えると、長命ブランチに近づくとも書いています。

    Git Flowの考案者であるVincent Driessenさん自身も、2020年に補足を加えています。継続的デリバリーをしているチームには、GitHub flowのようなもっと単純な流れを勧めています。

    一方で、版を明示して管理するソフトや、複数の版を市場で保守するソフトには、Git Flowが今も合う場合があります。原典の追記で読めます。

    つまり、戦略に優劣があるわけではありません。自分のソフトが「いつ・どんな単位で」利用者に届くかによって、適した形が決まります。

    【仕組み】 関門の通過と版番号の履歴

    画像
    マージで終わらず、検証・タグ・本番・監視・戻せる備えまでが一つの経路

    この仕組みの中心は、変更の通り道に関門を並べ、通過の記録を残すことです。

    関門を通る道筋は、Issue、機能ブランチ、PR、レビュー、マージの順です。原文は「早めにPRを開いて、チームに見えるようにする」ことを勧めています。

    基本形はGitHub公式のGitHub flowと同じで、ブランチを作り、PRで確認してもらい、承認後にマージして、ブランチを消します。

    マージのあとも続きます。原文が描く本番までの道筋は、CI/CD、ステージング、テスト、バージョンタグ、本番です。

    CI/CDは、検査と配備を自動で回す仕組みです。ステージングは、本番に近い確認用の環境です。

    配備の関門は、GitHub Actionsの「環境」機能でも作れます。必須レビュアーは、ユーザーまたはチームを合わせて最大6件まで指定できます。

    自分が起動した配備を、自分で承認できないようにする設定もあります。説明はGitHub Docsにあります。

    プランによっては、この保護規則を公開リポジトリでしか使えない場合があります。導入前に、自分のプランを確認してください。

    版番号には、セマンティックバージョニングを使います。互換性を壊す変更ならMAJOR、互換性を保った機能追加ならMINOR、互換性を保ったバグ修正ならPATCHを上げます。

    原文の例v1.4.0は、この三つの数字の並びです。

    版番号は単なる連番ではありません。「この数字が上がったら、利用者に何が起きるか」を伝える約束になります。

    【具体例】 直した結果を元の流れへ戻す障害対応

    画像
    原典の例:版1.2が稼働中に重大なバグが見つかり、developは不安定

    緊急でも品質の関門を外さないことと、直した内容を他のブランチへ返すことが、障害対応の中身です。

    原文の流れは、障害、ホットフィックスブランチ、最小限の修正、迅速に扱うPR、CI、マージ、デプロイです。そのあと、関係する開発ブランチやリリースブランチへ修正を戻します(バックマージ)。

    戻さないと、次のリリースで同じバグが再発するからです。

    原典のGit Flowには、具体的な場面があります。本番で版1.2が動いていて重大なバグが見つかりますが、developの変更はまだ不安定です。

    • masterからhotfix-1.2.1を切ります。

    • 版番号を上げ、バグを直します。

    • masterへマージして、1.2.1のタグを付けます。

    • developにもマージします。ただしリリースブランチが存在するときは、そちらへ入れます。

    この手順なら、developの作業を止めずに本番だけを直せます。原典に詳しい手順があります。

    原文との違いは、緊急時でもPRと自動チェックを通す点です。原典の手順はmasterへ直接マージする書き方なので、原文は現代のGitHub運用に合わせて関門を足したと読めます。

    この対応づけは、私の整理です。

    【関連概念】 頻度と失敗率で測る運用の良し悪し

    画像
    仕組みの効果を確かめる物差しと、隣り合う考え方

    関連する考え方を知ると、ここまでの仕組みが役に立っているかを数字で見られます。

    • DORAの指標:ソフトウェア開発の成果を測る調査プログラムの指標で、DORAの解説では5つです。この記事で触れるのは、デプロイ頻度、変更失敗率(ロールバックやホットフィックスが要るデプロイの割合)、失敗したデプロイからの復旧時間です。

    • GitHub flow:ブランチを作り、変更をPRで確認し、マージしたあとブランチを消す、単純な運用です。トランクベースに近い考え方として読めます。

    • 環境の保護規則:配備先ごとに承認者や使える分岐を決める機能です。

    この三つは、記事の線に対応しています。ブランチ戦略は頻度に、関門は失敗率に、ホットフィックスと復旧時間は障害対応に結びつきます。

    参考情報・参考書籍(PR)

    本記事をより深く理解するために、概念マップスライドを作成しました。こちらをみることで理解の補助になるはずです。

    【まとめ】 四つの領域で点検する自分のリポジトリ

    画像
    起点の最終チェックリストを、自分のリポジトリへの問いに変える

    まず、原文の最終チェックリストを、自分のリポジトリに当てはめてみてください。

    四つの領域と、それぞれで確認する問いを書きます。

    1. リポジトリの準備:mainは保護されていますか。CODEOWNERSとテンプレートはありますか。

    2. ブランチ:自分のリリース頻度に合う戦略ですか。ブランチは短命ですか。

    3. CI/CD:テスト、ビルド、セキュリティスキャン、自動デプロイが揃っていますか。

    4. 障害への備え:ホットフィックスの手順、ロールバック計画、監視、バックマージは決まっていますか。

    空欄が一番大きい領域を一つだけ選んでください。全部を一度に整える必要はありません。

    おすすめは、保護ブランチと必須チェックの設定です。小さく入れられて、効果もすぐ見えます。

    参考情報

     
     
    海外でバズった最新テック関連情報をわかりやすく整理します! スキの数やページビューが多いなどの反響が多いものがあれば、実際の環境で操作した結果や手順などを共有する記事も作成したいとも思ってます! とりあえずこれを見ておけばディープな最新情報もキャッチアップ!できるものを目指します

    あなたへのおすすめ