緊急修正のためのhotfixブランチ命名

緊急の本番パッチ用にhotfixブランチに適切な名前を付けます。Gitflowや類似のブランチモデルで使用されるhotfix/プレフィックス規約に従います。

Branch Types

詳細な説明

hotfixブランチの命名

hotfixブランチは、次のスケジュールされたリリースを待てない重大な問題が本番環境で発見された場合に作成されます。最も優先度が高く、迅速なレビューとデプロイプロセスに従います。

標準フォーマット

hotfix/{ticket}-{description}

またはバージョンベースのhotfixの場合:

hotfix/v{version}-{description}

シナリオ ブランチ名
セキュリティ脆弱性パッチ hotfix/sec-001-patch-xss-vulnerability
データベース接続クラッシュ hotfix/hot-234-fix-db-connection-pool-exhaustion
決済処理障害 hotfix/inc-567-fix-stripe-webhook-timeout
バージョンベースパッチ hotfix/v2.1.1-fix-auth-token-expiry

Hotfixワークフローの統合

Gitflowでは、hotfixブランチには独自のライフサイクルがあります:

  1. main(または本番タグ)から分岐する
  2. 最小限の集中的な変更で修正を適用する
  3. maindevelop両方にマージして、次のリリースで修正が失われないようにする
  4. mainのマージコミットにパッチバージョン(例:v2.1.1)をタグ付けする

Hotfixの命名規約

hotfixブランチ名は、緊急性とスコープを即座に伝える必要があります。インシデントやセキュリティアドバイザリー番号(例:SEC-001INC-567)を含めることで、運用チームやセキュリティチームが修正を元のレポートまで追跡できます。ブランチ名はインシデント中にオンコールエンジニアが最初に目にするものなので、根本原因ではなく対処している具体的な症状に焦点を当てた説明にしてください。

最良のhotfix名は短く、正確で、問題を間違いなく特定するものです:hotfix/fix-payment-double-chargehotfix/payment-issueよりもはるかに優れています。

ユースケース

オンコールエンジニアが午前2時にPagerDutyアラートを受け、決済取引が二重請求されていることがわかりました。迅速なレビューのために問題をチームに明確に伝えるhotfixブランチをすぐに作成する必要があります。

試してみる — Git Branch Name Generator

フルツールを開く