日頃より、弊社をご愛顧いただきまして誠にありがとうございます。この度、弊社は商号を「ゴーツーグループ株式会社」から「ゴーツーラボ株式会社」に変更いたしました。詳細については、「商号変更のお知らせ」をご参照ください。

ユースケース : JIRA Software と Bitbucket との統合の強化 (3/3)

2016-04-06 (Wed) • By 伊藤 • 活用のヒント • Bitbucket Jira Software

はじめに

本資料は、JIRA Software (Server) と Bitbucket (Server) との連携を効率的に行うためのユースケースです。全部で 3 部構成となっており、それぞれの概要は以下のとおりです。

第 1 部 : JIRA Software (Server) と Bitbucket (Server) との統合に必要となるアプリケーションリンクの設定について解説しています。
第 2 部 : Bitbucket (Server) 上の Git リポジトリへのコミットアクティビティを JIRA Software (Server) 上で確認する方法について解説しています。
第 3 部 : 本ページです。Bitbucket (Server) 上の Git リポジトリへのコミットにおいて、コミットメッセージを検証する方法について解説しています。

なお、本ページは「ユースケース : JIRA Software と Bitbucket との統合の強化 (1/3)」および「ユースケース : JIRA Software と Bitbucket との統合の強化 (2/3)」で解説されている設定が完了してることが前提となっています。

Commit Policy Plugin for JIRA の設定

Commit Policy Plugin for JIRA は、ハンガリーのアトラシアンエキスパート Midori Global Consulting 社が開発する JIRA 用アドオンです。JIRA アプリケーションとバージョン管理システム (VCS) とを統合している環境において、JIRA アプリケーション上で定義したコミットポリシーを基に VCS 上でコミットメッセージの自動検証を行います。

Commit Policy Plugin for JIRA を使用することでコミットメッセージが条件を満たさないコミットをすべて拒否できるため、ソースコードの修正に関するトレーサビリティを向上できます。

なお、Commit Policy Plugin for JIRA では JIRA アプリケーション上でのコミットポリシーの定義の他にフックスクリプトの設定が必要となります。Bitbucket と統合している場合は無料のアドオン Commit Policy Plugin for Bitbucket を使用することで、フックスクリプトの設定を簡略化できます。

現時点では、JIRA プロジェクト デモプロジェクト の課題上で Bitbucket 上の Git リポジトリ demo-repo へのコミット情報を確認できるようになっています。ただし、これはコミットメッセージに JIRA プロジェクト デモプロジェクト の課題番号が含まれていることが前提条件となっています。コミッターがコミットメッセージに課題番号を含めるのを忘れてしまった場合、JIRA Software 上でそのコミットに関する情報を確認できません。しかし、Commit Policy for JIRA の機能を使用することで、これを防ぐことができます。

Commit Policy for JIRA を利用したコミットポリシーの設定の手順は、以下のとおりです。

JIRA Software と Bitbucket との間で認証を設定する。
JIRA Software 上でコミットポリシーを定義する。
Bitbucket 上の Git リポジトリに対してコミットポリシーを適用する。

JIRA Software と Bitbucket との間での認証の設定

JIRA Software と Bitbucket との間で OAuth 認証の設定を行います。JIRA Software 側では 受信認証 を、Bitbucket 側では 送信認証 を設定します。

JIRA Software 側の設定

管理者権限を持つユーザーとして JIRA Software にログインします。
ヘッダー右端のアイコン ([管理] メニュー) から [アプリケーション] オプションを選択します。

左ペインの [アプリケーションリンク] オプションを選択します。

Bitbucket のアイコン ([操作] ボタン) から [編集] オプションを選択します ([設定] ダイアログが表示されます)。

左ペインの [受信認証] オプションを選択します。
右ペインの [OAuth] タブを選択します。

[2-Legged OAuth] オプションにチェックが入っていることを確認します。
[2-Legged OAuth を通してユーザーの偽装を許可] オプションにチェックを入れます。

[更新] ボタンをクリックします。
右下の [閉じる] リンクをクリックします。

Bitbucket 側の設定

管理者権限を持つユーザーとして Bitbucket にログインします。
ヘッダー右端のアイコン ([管理] メニュー) をクリックします。

左ペインの [アプリケーションリンク] オプションを選択します。

JIRA Software の [編集] オプションを選択します ([設定] ダイアログが表示されます)。

左ペインの [送信認証] オプションを選択します。
右ペインの [OAuth] タブを選択します。

[2-Legged OAuth 送信リクエストの有効化] オプションにチェックが入っていることを確認します。
[偽装あり 2-Legged OAuth 送信リクエストの有効化] オプションにチェックを入れます。

[更新] ボタンをクリックします。
右下の [閉じる] リンクをクリックします。

JIRA Software 上でのコミットポリシーの定義

次にコミットポリシーを JIRA Software 上で定義します。今回は Git リポジトリ demo-repo へのコミットのコミットメッセージに必ず JIRA プロジェクト デモプロジェクト の課題の課題番号が 1 つだけ含まれているようにします。

JIRA Software 上でコミットポリシーを定義するには、以下の操作を行います。

管理者権限を持つユーザーとして JIRA Software にログインします。
ヘッダー右端のアイコン ([管理] メニュー) から [Commit Policies] オプションを選択します (コミットポリシーが未定義なので [Add Commit Policy] 画面が表示されます)。

[Name] フィールド、[Description] フィールド、および [Rejection message] フィールドに必要事項を入力します。
[Add rule] ボタンをクリックします。

[Add condition] ドロップダウンから [Commit message must contain issue keys from a JQL query] オプションを選択します。

左側のドロップダウンから [exactly one issue] オプションを選択します。
右側のフィールドには、以下の JQL (JIRA クエリ言語) を入力します。

project = DEMO

[Save] ボタンをクリックします。

Bitbucket 上の Git リポジトリへのコミットポリシーの適用

前セクションで JIRA Software 上で定義したコミットポリシーを Bitbucket 上の Git リポジトリ demo-repo に割り当てます。Commit Policy Plugin for Bitbucket を使用することで、この操作は Git リポジトリの設定画面上で行えます。

Bitbucket 上の Git リポジトリ demo-repo にコミットポリシーを割り当てるには、以下の操作を行います。