はじめに
こんにちは、JetBrains公式代理店NATTOSYSTEMのねばねばです。
今回は、JetBrains IDEとYouTrackを連携させて、IDEを中心にした課題管理フローを紹介します。
JetBrains IDE と YouTrack を併用していると、
- Issueを確認するために毎回ブラウザを開いている
- Issueの状態更新やコメントが後回しになりがち
- コミットとIssueの紐付けが曖昧になる
これらは YouTrack Plugin を使うことで解消できます。
YouTrackとは？
YouTrack は JetBrains が提供する 課題管理・プロジェクト管理ツール です。
ソフトウェア開発を中心に、以下の機能をご利用いただけます。
- バグ・タスク・要望の管理
- アジャイル開発（Scrum / Kanban）
- ワークフロー・ステータス管理
- コメント・履歴によるコミュニケーション
- Git などのVCSとの連携
JetBrains IDE × YouTrack連携で何が変わるのか
JetBrains IDEとYouTrackを連携すると、次のような課題が解消されます。
- ブラウザでYouTrackを開かなくてもIssue確認・更新ができる
- Issueとコード変更が自動的に紐づく
- コミットと同時にIssueの状態更新ができる
YouTrack Pluginとは
YouTrack Integration Plugin は、JetBrains IDEに標準搭載されている
- Issue Navigation
- Task Management
といった機能を拡張し、YouTrackと連携する公式プラグインです。
対応IDE
- IntelliJ IDEA
- その他すべてのJetBrains IDE
インストールと初期設定
プラグインのインストール
- IDEの 設定 → プラグイン
- Marketplaceで YouTrack を検索
- インストールしてIDEを再起動
YouTrackへの接続
IDEの **設定 → ツール → タスク → サーバー **
-
YouTrackのURLを指定
-
Permanent Token を入力
設定完了後、IDE内に YouTrackツールウィンドウ が表示されます。
IDE内でIssueを一覧・検索する
YouTrackツールウィンドウ
デフォルトでは、
- 自分に割り当てられた未解決Issue
を取得する検索クエリが設定されています。
この検索クエリは、ツールウィンドウ内で直接編集できます。
project: SampleProject State: Open
プロジェクトごとに切り替えることで、
今作業しているIssueだけに集中できます。
Issue詳細の確認
Issueを選択すると、右ペインに以下が表示されます。
- 説明文
- コメント
- タグ
- Issueリンク
- 添付ファイル
重要なIssueは ピン留め して常時表示できます。
IssueをTaskとして扱う
YouTrack Integration Pluginの真価は、
Issueを Task Management機能と連携 できる点にあります。
Open Task
Issueを選択して Open Task を実行すると、
- Issue単位で作業コンテキストを管理
- VCS（Gitなど）と連携
といった操作が可能になります。
Task作成時にできること（VCS依存）
- Issue状態の変更
- ブランチ作成
- Changelistの作成
作業開始前にIssueを更新する
作業前に Apply Command ダイアログ を使ってIssueを更新できます。
例：
- 状態を
In Progressに変更 - 担当者を自分に設定
さらに、
- タグ追加
- カスタムフィールド更新
- ウォッチャー追加
- コメント投稿
なども可能です。
ChangelistとIssueの自動連携
TaskとしてIssueを開くと、
- Issue ID + Summary を含む
- 専用のChangelist
が自動で作成されます。
Version Controlツールウィンドウでは、
- Issue IDがYouTrackへのリンクとして表示
- 修正ファイルが自動的に紐づく
ため、複数Issueを並行して扱っても混乱しません。
コミットと同時にIssueを更新する
コミットメッセージの自動生成
- Issue ID
- Issue Summary
が設定に応じて自動挿入されます。
コミットメッセージでYouTrack操作
#Ready
のようなコマンドを含めることで、
- コミットと同時に
- Issueの状態を更新
できます。
コミット履歴からIssueを辿る
Version Controlのログビューでは、
- コミットメッセージ内のIssue IDが
- YouTrackへのリンクに変換
され、変更の背景を即座に確認できます。
まとめ
JetBrains IDE × YouTrack Plugin を使うことで、
- IDEから離れずに課題管理
- Issueとコード変更の明確なトレーサビリティ
- 状態更新・コミットを一連の流れで実行
が可能になります。
YouTrackを使っているなら、IDE連携をぜひご利用ください。
ナットウシステムからのお知らせ
NATTOSYSTEMはJetBrains製品に関するご質問、ご相談等を受け付けております。
ちょっとした疑問、質問でも構いませんので、弊社のXまたはメールでご連絡ください。
参考資料
YouTrack 公式サイト
https://www.jetbrains.com/ja-jp/youtrack/
YouTrack Integration Plugin（JetBrains Marketplace）
https://plugins.jetbrains.com/plugin/8215-youtrack-integration
YouTrack 公式ドキュメント日本語版
https://pleiades.io/help/youtrack/
JetBrains IDE Task Management 概要日本語版
https://pleiades.io/help/idea/managing-tasks-and-context.html