JIRAチケット番号からのGitブランチ名

PROJ-1234のようなJIRAチケットキーからgitブランチ名を生成します。一貫した命名でJIRA IssueとgitブランチのトレーサビリティをMaintainします。

Integration Patterns

詳細な説明

JIRAチケットのブランチ名

JIRAチケットキーはPROJECT-NUMBER形式(例:PROJ-1234AUTH-567)です。ブランチ名にJIRAキーを含めることで、プロジェクト管理ツールとgitリポジトリ間の自動的なトレーサビリティが生まれます。

標準フォーマット

{type}/{jira-key}-{description}

JIRAチケット タイトル ブランチ名
AUTH-1234 SSO loginの実装 feature/auth-1234-implement-sso-login
PLAT-567 データベースタイムアウトの修正 bugfix/plat-567-fix-database-timeout
DEVOPS-89 Terraformモジュールの更新 chore/devops-89-update-terraform-modules
UI-2345 設定ページのリデザイン feature/ui-2345-redesign-settings-page

JIRA Smart Commitsの統合

ブランチ名にJIRAチケットキーが含まれている場合、多くのツールが自動リンクを提供します:

  • Bitbucketはブランチ名にキーが含まれている場合、ブランチをJIRA Issueに自動的にリンクします
  • GitHub(JIRA連携機能付き)はJIRA Issueサイドバーにブランチ情報を表示します
  • GitLabはブランチにキーが含まれている場合、マージイベントに基づいてJIRA Issueのステータスを遷移できます

JIRA固有の命名のコツ

  1. キー形式を保持する — プロジェクトプレフィックスと番号をまとめて保持:auth-1234auth/1234ではなく
  2. 大文字小文字 — JIRAキーは大文字小文字を区別しませんが、小文字のブランチ名が慣例:AUTH-1234ではなくauth-1234
  3. 複数チケット — ブランチが複数のチケットに対処する場合、プライマリチケットを使用:feature/auth-1234-implement-sso、セカンダリチケットはコミットメッセージで参照
  4. Epicブランチ — Epicの下で複数のチケットにまたがる作業には、Epicキーを使用:feature/epic-100-user-management

テンプレート設定

ブランチテンプレートを{type}/{ticket}-{title}に設定し、チケットフィールドに完全なJIRAキー(例:AUTH-1234)を入力します。ツールはキーを小文字に正規化し、選択した規約を使用してタイトルと結合します。

ユースケース

JIRAとBitbucketを使用する開発チームが、JIRAのスマートコミット連携でブランチをチケットに自動的にリンクし、Issue Trackerで開発進捗を表示するための一貫したブランチ命名方法が必要です。

試してみる — Git Branch Name Generator

フルツールを開く