Jenkins との連携

Jenkins for Jira は、ファイアウォールの内側で実行されている Jenkins サーバーを Jira Cloud または Jira Service Management Cloud のいずれかと接続するための安全で信頼できる手段として無料で利用できるものです。

これによって、チームは Jira のすべての課題の詳細ビューで可視性とコンテキストを活用して、最新のビルド ステータスや、その作業が環境に正常にデプロイされたかどうかを確認できるようになります。

また、この情報によって Jira クエリ言語 (JQL) で複数の課題全体を検索して「現在のスプリントのどの課題が本番環境にデプロイされたか」などの質問に回答できるようになります。これらをボード上にクイック フィルターとして追加するさえもできます。

はじめる前に

Jenkins for Jira を接続して Jira プロジェクトにデータを流すには、次のタスクを実行または委任する必要があります。

1. Jira で Jenkins for Jira アプリをインストールする

2. Jira で Jenkins への接続を開始する

3. Jenkins でアトラシアンの Jira Cloud プラグインをインストールする (必要な場合)

4. Jenkins で、Jira に用意されている接続認証情報を入力して接続を完了する

5. ソース コード管理プラットフォームか Jenkins で、プロジェクトの Jenkinsfiles を編集して Jenkins から Jira に送信されるデータを設定する

多くのチームでは、これらのタスクを適切な権限と経験を持つチーム メンバーに分けるのが理にかなっています。

Jenkins for Jira の接続プロセスを参考にして、これらのタスクを委任してください。ただし、始める前に、Jenkins 管理者が誰で、どのチーム メンバーが Jenkins パイプラインを定義する Jenkinsfiles の編集を担当しているかを知っておく必要があります。

これらのチーム メンバーが誰なのかわからない場合は、Jenkins を使用してコードをビルドおよびデプロイしている Jira プロジェクト チームに連絡してください。Jira プロジェクト チームが該当する担当者を教えてくれます。

Jira Cloud サイトに Jenkins for Jira をインストールする

Jenkins for Jira (公式) アプリを Atlassian Marketplace からインストールします。

1. Jira サイトにログインして [アプリ] > [その他のアプリを探す] の順に移動します。

2. Jenkins for Jira (公式) アプリを検索して、[アプリを入手] を選択します。

Jira で Jenkins への接続を開始する

Jenkins for Jira アプリを Jira サイトにインストールしたら、Jenkins への接続を開始する必要があります。

1. Jira で [アプリ] > [アプリを管理] の順に移動します。

2. 左側のサイドバーの [アプリ] の下で、[Jenkins for Jira] を選択します。

3. これが初めての接続である場合は、接続ウィザードが表示されます。以前に Jenkins サーバーに接続したことがある場合は、[Connect another server (別のサーバーに接続)] を選択してウィザードに進みます。

接続ウィザードの画面に表示される指示に従います。Jenkins 管理者である場合と Jenkins 管理者のサポートを受けている場合でここでの操作は異なりますが、いずれの場合も、サーバーに名前を付けると、2 つの認証項目 (Webhook URL と Jenkins で使用するシークレット トークン) が表示されます。

接続プロセスを完了するには、あなたまたは Jenkins 管理者が Jenkins にログインし、サーバーをセットアップし、これらの認証情報を使用して接続を完了する必要があります。

Jenkins サーバーにアトラシアンの Jira Cloud プラグインをインストールする

Jira サイト管理者が Jira で接続を開始したら、Jira Cloud プラグインを Jenkins にインストールして接続を完了する必要があります。

1. Jenkins サーバーにログインして、[Jenkins の管理] > [Plugins (プラグイン)] > [Available plugins (利用可能なプラグイン)] の順に移動します。

2. アトラシアン Jira Software Cloud を検索して、プラグインをインストールします。

[Available plugins (利用可能なプラグイン)] 画面でプラグインが見つからない場合は、すでにサーバーにインストールされている可能性があります。確認方法は次の通りです。

1. Jenkins サーバーにログインして、[Jenkinsの管理] > [Plugins (プラグイン)] > [インストール済みプラグイン] の順に移動します。

2. アトラシアン Jira Software Cloud を検索します。

3. プラグインがすでにインストールされている場合は、利用可能なアップデートを実行します。

Jenkins サーバーで接続を完了する

Jenkins サーバーにアトラシアン Jira Software Cloud プラグインがインストールされ、Webhook URL とシークレット トークンが手元にあれば、Jenkins と Jira 間の接続を完了させることができます。

1. Jenkins で、[Jenkins の管理] > [Atlassian Jira Software Cloud (アトラシアン Jira Software Cloud)] の順に移動します。

2. [Add new site (新しいサイトを追加)] を選択します。

3. Jira サイト名を入力します。

4. Webhook URL を入力します。

5. Jenkins の認証情報マネージャーを使用してシークレットを入力します。

   1. [追加] を選択します。

   2. [Kind (種類)] ドロップダウンから、[Secret text (シークレットのテキスト)] を選択します。

   3. Jenkins for Jira 接続ウィザードで指定されたシークレットを [シークレット] フィールドに貼り付けます。

   4. シークレットの分かりやすい名前 (サイト名など) を [説明] フィールドに指定します。

   5. [追加] を選択します。

   6. [シークレット] ドロップダウンを使用して、先ほど入力したシークレットを選択します。

6. [Test connection] を選択して、Jira サイトで認証情報が有効であることを確認します。

7. [保存] を選択します。

8. サイト名と認証情報を正常に入力すると、[Jenkins の管理] > [Atlassian Jira Software Cloud (アトラシアン Jira Software Cloud)] に戻ります。

9. (オプション）チームで必要な場合は、ビルドとデプロイの自動化をセットアップします。

10. [保存] を選択します。

この時点で Jenkins サーバーが Jira に接続されます。

Jenkins 管理者として接続プロセスを完了させるために Jira サイト管理者をサポートしている場合は、接続が完了したことを Jira サイト管理者に知らせます。Jenkins 権限を持つ Jira サイト管理者 (つまり、セットアップをすべて自分で完了する場合) の場合は、このタイミングで Jira に戻ります。

Jenkinsfile を編集して Jenkins サーバーから Jira サイトへのデータフローを設定する

Jenkins サーバーが Jira に接続されると、サーバーから Jira に流れるデータをチームで選択するうえで役立つセット アップ ガイドが Jira によって生成されます。Jenkins からビルドとデプロイのイベントを受信するには、チームでこのガイドに従う必要があります。

サーバーのセット アップ ガイドにアクセスする方法は以下のとおりです。

1. Jira で [アプリ] > [アプリを管理] の順に移動します。

2. 左側のサイドバーの [アプリ] の下で、[Jenkins for Jira] を選択します。

3. 先ほど選択したサーバーに移動し、[Set up guid (セットアップ ガイド)] タブを開きます。このガイドでは、Jenkins と Jira の間のデータの流れを設定するためにチームですべきことが説明されています。

4. ほとんどの場合、セット アップ ガイドの情報はプロジェクト チームの開発者が最もよく使用します。[Share this guide with your team (このガイドをチームと共有)] を使用し、Jenkins 管理ページの読み取り専用バージョンのガイドをチームに送信します。

5. Jenkins サーバーから Jira に送信するビルド イベントをチームで設定すると、それらのイベントがサーバーの [Recent events (最近のイベント)] タブに表示されるようになります。

Jenkins for Jira の仕組み

Jenkins for Jira と Jenkins サーバー向け Atlassian Jira Software Cloud プラグインが連携する仕組みに関する詳細な説明は、「Jenkins for Jira の仕組み」をご参照ください。このトピックは、Jenkins 管理者がビルド イベントやデプロイ イベントの自動送信などの詳細オプションをセットアップする際に役立つでしょう。