Jira Cloud 製品のご紹介
Jira Cloud の製品、機能、プラン、および移行の詳細をご確認ください。
Jira 向け GitHub アプリの使用
このドキュメントを読み終える頃には、開発情報を GitHub から Jira に簡単にリンクし、Jira 課題で GitHub Actions からインサイトを直接取得し、より効果的な管理のためにデプロイ環境を巧みにマッピングできるようになります。
Jira 課題で GitHub 情報を表示する
コミット メッセージ、ブランチ名、またはプル リクエストのタイトルに Jira 課題キーを追加するだけで、Jira で GitHub 開発データを表示できます。たとえば、これらの場所のいずれかに [DEV-2095] を含めると、キー DEV-2095 で Jira 課題にデータがリンクされます。課題キーの参照に関する詳細をご確認ください。
Jira Software プロジェクトでコミット情報がどのように表示されるかの例
開発者がコミットを作成する場合、以下のように、Jira Software の課題キーをコミット メッセージに追加する必要があります。
1
2
git commit -m "PROJ-123 add a README file to the project."
git push origin <branchname>Jira Software は課題キーを使用してコミットを課題に関連付けます。これにより、コミットの概要を Jira Software 課題の開発パネルに表示できるようになります。
プロジェクトのユーザーは、JIRA Software 課題の開発パネルでコミット情報を見るために「開発ツールを表示」権限を持っている必要があります。JIRA Software 管理者は、プロジェクトの権限スキームを編集してこの権限を付与できます。プロジェクト権限の管理に関する詳細についてご確認ください。
GitHub で Jira 課題を表示する
GitHub で Jira 課題を表示するには、有効な Jira 課題キーを括弧で囲んでコメントに記載します (例: [DEV-2095])。自動的に Jira 課題へのリンクに変わります。これを機能させるには括弧が必要であることに注意してください。
GitHub Actions の統合
GitHub Actions のワークフローとデプロイは、Jira インスタンスと自動的に同期されます。これが初めての場合は、GitHub Actions のドキュメントをご確認ください。GitHub の CI/CD データを Jira で表示するには、コミット メッセージ、ブランチ名、またはプル リクエストのタイトルに Jira 課題キーを含めます。詳細については、ビルドとデプロイに関するガイドをご確認ください。
Jira で GitHub ビルドを表示する
Jira 向け GitHub では、GitHub リポジトリで定義されている GitHub アクション ワークフローから「ワークフロー実行」が自動的に処理され、課題の開発情報セクションの [ビルド] タブに表示されます。
ワークフロー実行と Jira 課題の関連付け
ワークフロー実行と Jira 課題を関連付けるために、プル リクエストに関連するすべてのコミット メッセージで Jira 課題キーがアプリによって検索されます。これにより、Jira プラットフォームから直接ビルドを効率的に表示できます。
これを示す例は次のとおりです。
main ブランチから分岐しているフィーチャー ブランチが 2 つあり、フィーチャー ブランチ (緑のドット) と main ブランチ (青のドット) の両方のすべてのコミットで、コードベースを構築してテストするワークフローがトリガーされるように GitHub Actions が設定されていると仮定します。
コミット メッセージに Jira 課題キー (JIRA-*) を含めることで、関連する Jira 課題内の特定のワークフロー実行を表示できます。たとえば、ワークフロー実行 #6 が Jira 課題 JIRA-1 と JIRA-2 に表示されるのに対して、ワークフロー実行 #7 は Jira 課題 JIRA-1、JIRA-10,、JIRA-11 に表示されます。ワークフロー実行 #2 は Jira 課題 JIRA-1 にのみ関連付けられます。JIRA-1 と JIRA-2 は両方とも同じプル リクエストの一部であるため、ワークフロー実行 #4 はこれら両方に関連付けられます。
注: アプリでは、プル リクエストの一部であるコミットで Jira 課題キーだけが検索されます。プル リクエストのないブランチをマージすると、アプリではそのブランチの最後のコミット メッセージで Jira 課題キーのみが検索されます。
GitHub ワークフローをプル リクエストで実行できるようにするには、プル リクエストのソース ブランチのブランチ名パターンを GitHub ワークフロー設定に次のように含めてください。
1
2
3
4
5
on:
pull_request:
branches:
- main
- feature**Jira で GitHub デプロイを表示する
Jira 向け GitHub では、自分の GitHub デプロイを Jira で直接確認できます。これらのデプロイは、GitHub のデプロイ API を使用して作成された場合は Jira 課題に表示されます。
デプロイと Jira 課題の関連付け
前回デプロイが成功してからデプロイされたブランチのすべてのコミット メッセージで Jira 課題キーをスキャンすることで、デプロイが Jira 課題にリンクされます。
これを示す例は次のとおりです。
main ブランチから分岐するフィーチャー ブランチが 2 つあり、main ブランチでプッシュするたびにデプロイがトリガーされるように GitHub Actions が設定されていると仮定します。
コミット メッセージに Jira 課題キー (JIRA-*) を含めると、対応する Jira 課題に関連するデプロイが表示されます。たとえば、失敗したデプロイ #6 は Jira 課題 JIRA-1 と JIRA-2 に表示され、デプロイ #7 は関連するすべての Jira 課題に表示されます (どのコミットもまだ正常にデプロイされていないため)。
GitHub Actions ワークフローの一部としてデプロイを作成するために、デプロイ アクションを利用できます。デプロイを作成するにはアクション chrnorm/deployment-action@releases/v1 を使用します。chrnorm/deployment-status@releases/v1 を使用してデプロイの状態を更新するのを忘れないようにしてください。
Jira 向け GitHub アプリがリッスンするのは deployment_status イベントのみである点に注意してください。デプロイ作成 API または chrnorm/deployment-action@releases/v1 アクションを使用して単にデプロイを作成するだけでは不十分です。デプロイを作成したら、デプロイ ステータス作成 API (または chrnorm/deployment-status@releases/v1 アクション) を少なくとも 1 回呼び出して、そのデプロイのステータス (成功、失敗、保留中など) を更新する必要があります。
環境マッピング
すべてのデプロイ イベントには、アプリがデプロイされる環境の名前が含まれます。課題とデプロイのビューを最適化するには、環境が development、testing、staging、production どれであるかを Jira に通知する必要があります。
それに応じて、GitHub の統合で環境名から環境タイプの推測が試行されます。たとえば、「prod」という単語が含まれている場合は production 環境であるとみなされます。「test」という単語があれば testing 環境とみなされるといった具合です。
環境にカスタム名や英語以外の名前を使用すると、正しい環境タイプが特定されず、Jira に「未定義の環境」メッセージが表示されることがあります。これを解決するには、.jira/config.yml ファイルをリポジトリのメイン ブランチに追加し、カスタム環境名を Jira で認識する標準環境名にマッピングします。
例を以下に示します。
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
deployments:
environmentMapping:
development:
- "dev*"
- "Entwicklung"
- "desenvolvimento"
- "дев"
testing:
- "testes"
- "Test"
- "TST-*"
- "тест"
staging:
- "Pre-Prod"
- "STG-*"
- "staging"
production:
- "Produktion"
- "produção"
- "продакшн"
- "PROD-*"この設定では、Jira の4つの有効な環境タイプのそれぞれに最大 10 個の glob パターンを指定できます。たとえば、デプロイ イベントの環境名が「TST-3」の場合、Jira では testing 環境へのデプロイとして識別されます。環境名が「produção」の場合、Jira では production 環境とみなされます。
注: この設定ファイルを追加すると、自動検出が機能しなくなります。すべての環境名にパターンを指定する必要があります。
自動化
リポジトリ アクティビティを使用して、企業管理対象プロジェクトの課題を自動でアップデートする
企業管理対象のソフトウェア プロジェクトでは、GitHub リポジトリでアクティビティが発生したときに、課題のワークフローを自動化して課題をトランジションできます。
これを行う際は Automation for Jira のご利用をお勧めします。ワークフローを自動化するには、次の手順に従います。
企業管理対象プロジェクトに移動します。
[プロジェクト設定] > [Automation] の順に選択します。
[ライブラリ] タブを選択します。
[DevOps] で、事前設定されたルールのいずれかを選択します。
ルールの設定をプレビューするときに、[オンにする] を選択して有効にします。
プロジェクトの Automation ライブラリには、接続されたソース コード ツールで開発が行われたときに、ワークフローに沿って課題をトランジションする 3 つの事前設定ルールが用意されています。
ブランチが作成されたら → 課題を「進行中」に移動
コミットしたら → 課題を「進行中」に移動
プル リクエストがマージされたら → 課題を「完了」に移動
ソース コード トリガーを使用して、Jira プロジェクトの他の部分を自動化できます。Automation for Jira の詳細をご確認ください。
この内容はお役に立ちましたか?