カスタムブランチ名テンプレートとパターン
{type}、{ticket}、{title}変数を使用してカスタムブランチ名テンプレートを作成し、チームの特定の命名規約やCI/CD要件に合わせます。
Best Practices
詳細な説明
カスタムブランチ名テンプレート
Git Branch Name Generatorは、3つの変数({type}、{ticket}、{title})を使用するテンプレートシステムを使用しており、チーム固有の規約に合わせて任意の順序と任意のセパレーターで配置できます。
組み込みテンプレート
| テンプレート | 出力例 |
|---|---|
{type}/{ticket}-{title} |
feature/proj-123-add-auth |
{type}/{title} |
feature/add-auth |
{ticket}-{title} |
proj-123-add-auth |
{type}/{ticket}/{title} |
feature/proj-123/add-auth |
高度なテンプレートパターン
チームはテンプレートにリテラルテキストを追加して、より複雑なパターンを作成できます:
| テンプレート | 出力例 | ユースケース |
|---|---|---|
{type}/user/{ticket}-{title} |
feature/user/proj-123-add-auth |
ユーザーネームスペース |
{type}/{ticket}-wip-{title} |
feature/proj-123-wip-add-auth |
作業中マーカー |
{type}/v2/{ticket}-{title} |
feature/v2/proj-123-add-auth |
バージョンスコープ |
テンプレート変数の動作
各変数は独立して置換およびサニタイズされます:
{type}— 選択されたブランチタイプ(feature、bugfixなど)に置換。常に小文字、変更なし。{ticket}— チケット/Issue入力に置換。オプション(小文字化、特殊文字除去)に従ってサニタイズ。GitHub Issueの#プレフィックスは除去。{title}— タイトル/説明に置換。スペースは規約のセパレーターに変換、特殊文字は除去、オプションが有効な場合は小文字化。
チーム規約の例
GitHub Issueを使用するスタートアップ:
テンプレート: {type}/{ticket}-{title}
結果: feature/123-add-user-auth
JIRAとチームネームスペースを使用するエンタープライズ:
テンプレート: {type}/backend/{ticket}-{title}
結果: feature/backend/plat-1234-api-redesign
ソロ開発者、日付ベース:
テンプレート: {type}/{title}
結果: feature/add-dark-mode
テンプレート選択のコツ
- チームがIssueトラッカーを使用している場合は
{ticket}を含める — トレーサビリティは非常に価値がある - 必要に応じて開発者が手動でブランチ名を入力できるほどシンプルにする
- 切り詰めが適切な結果を生むか、長いタイトルでテンプレートをテストする
- 選択したテンプレートをリポジトリのCONTRIBUTING.mdファイルに文書化する
ユースケース
チームリーダーが、チーム名をネームスペースとして含み、JIRAベースのワークフローと統合し、CI/CDアーティファクトの命名に十分短いカスタムブランチ命名テンプレートを確立したいと考えています。