Jira Software Cloud を Jenkins と連携する

OAuth を使用した自己ホスト型ツールとの連携

このページの内容

お困りですか?

アトラシアン コミュニティをご利用ください。

コミュニティに質問

この連携は、ファイアウォールの背後で実行されている Jenkinsサーバーと Jira Software Cloud を接続するための、簡単かつ安全で信頼できる無料の方法を提供します。パイプライン ステップを定義する Jenkinsfile にいくつかの行を追加すると、連携機能によってビルド データおよびデプロイ データの Jira への送信が開始され、関連する Jira 課題に関連付けられます。

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

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

はじめる前に

時間: 15-30 分

前提条件

  • Jira Software Cloud サイトのサイト管理者であること。

  • Jenkins の管理者であり、プラグインをインストール、更新、および削除できること。

  • Jenkins で "Multibranch Pipeline" (現在 Jenkins でサポートされている唯一の項目) を使用していること

  • 自身のソース コード / リポジトリで、この連携で使用するパイプラインの Jenkinsfile を編集できること。

  • チームは課題キー (例: FUSE- 123) をコミット メッセージ (デプロイ情報用) およびブランチ名 (ビルド情報用) の一部として追加する必要があります。チームがこのパターンに従っていない場合は、こちらで詳細をご確認ください


Jira Software Cloud と Jenkins のリンク方法

Jenkins 用の OAuth 認証情報を Jira で作成

  1. Jira ホーム > [Jira 設定] > [アプリ] に移動します。

  2. [OAuth 認証情報] を選択します。

  3. [認証情報の作成] を選択します。

  4. 以下の詳細を入力してください。

    • アプリ名 - Jenkins

    • アプリ ロゴ - Jenkins ロゴへの URL。認証情報の一覧でアイコンとして使用されます。例: https://jenkins.yourcompany.com/logo.png

    • サーバー ベース URL - Jenkins サーバーへの URL。例: https://jenkins.yourcompany.com/


Jenkins プラグインのインストール

  1. Jenkins サーバーにログインして Plugin Manager に移動します。

  2. [Available] タブを選択し、プラグイン名として "Atlassian Jira Software Cloud " を検索してインストールします。

追加情報:


Jenkins 認証情報のセットアップ

  1. Jenkins の [Manage Jenkins] > [Configure System] 画面で、[Jira Software Cloud integration] セクションまでスクロールします。

  2. [Add Jira Cloud Site] > [Jira Cloud Site] を選択します。[Site name]、[ClientID]、[Secret] フィールドが表示されます

  3. 以下の詳細を入力してください。

    • Site name: Jira Cloud サイトの URL。例: yourcompany.atlassian.net

    • Client ID: [OAuth 認証情報] 画面 ([クライアント ID] 列) からコピーします。

    • Secret: [Add] > [Jenkins] を選択します。

      • [Kind] では、[Secret text] を選択します。

      • [Secret] は、[OAuth 認証情報] 画面 ([シークレット] 列) からコピーします。

      • [Description] には説明を指定します。

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

連携の使用方法

連携の使用を開始する方法

  1. Jenkins で特定のパイプラインに移動します。

  2. 左側のメニューから [Pipeline Syntax] を選択します。

  3. Snippet Generatorで、Samlple Steps のドロップダウン リストから [jiraSendDeploymentInfo] または [jiraSendBuildInfo] を選択し、関連する詳細を入力します。

  4. [Generate Pipeline Script] を選択して出力をコピーし、Jira を通知したい Jenkinsfile にコピーして貼り付けます。


ビルド情報を送信する場合

これは、Jenkinsfile の非常にシンプルな "ビルド" ステージのセットアップのスニペットの例です。これは、パイプラインの実行後、ブランチ名を確認し、ビルド情報を Jira Cloud サイトに post します。ブランチ名に Jira 課題キー (例: “TEST-123”) が含まれる場合は、データを Jira に送信します。

stage('Build') {
   steps {
       echo 'Building...'
   }
   post {
       always {
           jiraSendBuildInfo site: '<sitename>.atlassian.net'
       }
   }
}


デプロイ情報を送信する場合

これは、master ブランチへの任意の変更で実行されるステージのスニペットの例です。ここでも post ステップを使用して、デプロイ データを Jira と関連する課題に送信します。ここで、environmentIdenvironmentName、および environmentType を、Jira に表示したい内容に設定する必要があります。

stage('Deploy - Production') {
   when {
       branch 'master'
   }
   steps {
       echo 'Deploying to Production from master...'
   }
   post {
       always {
           jiraSendDeploymentInfo site: '<sitename>.atlassian.net', environmentId: 'us-prod-1', environmentName: 'us-prod-1', environmentType: 'production'
       }
   }
}


適切にセットアップされている場合、Bitbucket や GitHub などの SCM ツールでコミットを行うか PR をマージするたびに、そのリポジトリに指定した Jenkins パイプラインが実行されます。ビルドとデプロイの情報は、課題の詳細ビューの右側に表示されます。

詳細


最終更新日: 2019 年 9 月 31 日

この内容はお役に立ちましたか?

はい
いいえ
この記事についてのフィードバックを送信する
Powered by Confluence and Scroll Viewport.