YouTrack 統合プラグイン
YouTrack 統合プラグインは、JetBrains IDE に組み込まれているタスク管理プラグインの機能を拡張します。このプラグインは、すべての JetBrains IDE で使用できます。これには、AppCode、CLion、DataGrip、GoLand、IntelliJ IDEA、PhpStorm、PyCharm、Rider、RubyMine、RustRover、WebStorm が含まれます。このプラグインは Android Studio でもサポートされています。
このプラグインは、IDE で次の機能を有効にします。
IDE で特定の検索条件に直接一致する課題のリストを表示します。
メールクライアントや外部メッセージングクライアントに切り替えることなく、更新通知を受信します。
検索クエリを入力して、リスト内の特定の課題を見つけます。
IDE で作業コンテキストを設定するタスクとして課題を開きます。
IDE でコマンドダイアログを開き、YouTrack の課題にコマンドを適用します。
YouTrack の課題に取り組んだ時間を追跡および記録します。
Java コードの VCS 履歴およびコメントから YouTrack の課題にアクセスします。課題 ID へのこれらの参照は、YouTrack へのリンクとして自動的にフォーマットされます。これは課題ナビゲーションプラグインの機能を模倣しているため、個別に有効にする必要はありません。
さらに、このプラグインは YouTrack の IDE で開く機能を有効にします。
YouTrack サーバーから取得された課題のリストは、IDE でローカルにキャッシュされます。これは、オフラインでも課題を表示できることを意味します。
YouTrack 統合プラグインをインストールする
IDE でこのセットアップを直接実行します。YouTrack で何も構成する必要はありません。IDE のさまざまなプロジェクトのプラグイン設定を個別に構成できます。
YouTrack 統合プラグインをインストールするには:
IDE でプロジェクトを開きます。
プラグイン設定にアクセスします。
Windows および Linux の場合、プラグインを選択します。
ダイアログを開き、macOS の場合、プラグインを選択します。
ダイアログを開き、
マーケットプレースタブを選択します。
リストから YouTrack 統合プラグインを選択します。
インストールボタンをクリックしてください。
プラグインが IDE にインストールされます。
古い IDE では、変更を適用するためにアプリケーションを再起動する必要がある場合があります。新しい IDE では、プラグインをすぐに使用できます。
YouTrack アカウントを接続する
プラグインの使用を開始するには、まず YouTrack アカウントでサインインする必要があります。このためには、次の情報を提供する必要があります。
YouTrack サイトの Web アドレス (URL):
YouTrack アカウント用に生成された永久トークン。
YouTrack 統合プラグインを構成するには:
YouTrack ツールウィンドウを選択します。ツールボタンメニューが非表示の場合、 を選択します。
構成リンクをクリックします。
プラグイン設定ダイアログが開きます。
一般タブの設定を使用して、YouTrack サイトに接続します。
設定
説明
サーバー URL
YouTrack サイトの URL を入力します。
myjetbrains.com
でホストされている YouTrack クラウドインスタンスの場合は、末尾の/youtrack
を必ず含めてください。例:https://writing.myjetbrains.com/youtrack
永久トークン
YouTrack でユーザーアカウント用に生成された永続的なトークンを入力します。
YouTrack で永久トークンを生成する方法については、永久トークンを作成するを参照してください。
接続のテストボタンをクリックしてサーバーへの接続をテストします。
保存ボタンをクリックしてください。
IDE が YouTrack サーバーに接続するように設定されています。
YouTrack インストールが別の場所に移行されている場合、または別の YouTrack サイトの課題に対処したい場合は、IDE で設定 / 環境設定の セクションに移動し、新しいサーバーをリストに追加します。
YouTrack ツールウィンドウで課題を見る
YouTrack 統合プラグインは、YouTrack ツールウィンドウを IDE に追加します。
ツールウィンドウには、課題とタイムトラッキングの別々のビューがあります。
課題ビューは、次の 2 つのペインに分かれています。
左側のペインには、現在の検索条件に一致する課題のリストが表示されます。この検索クエリは、ツールウィンドウの上部にある入力フィールドでいつでも編集できます。このリストは、2 つの詳細レベルをサポートしています。
1 行表示では、課題の優先度、ID、概要、最後の更新の日時が表示されます。
コンパクトビューでは、カスタムフィールドの値も表示されます。
右側のペインに課題の詳細が表示されます。ここでは、課題 ID、概要、タグ、課題リンク、課題の説明、添付ファイルを見つけることができます。アクティビティストリームには、コメントと費やした時間の個別のタブが表示されます。説明とコメントは、YouTrack に示すようにフォーマットされています。
ツールウィンドウの左側にあるツールバーから、次のアクションにアクセスできます。
アクション | 説明 |
---|---|
リストのリフレッシュ | YouTrack サーバーから更新をプルします。検索クエリに一致するすべての課題がツールウィンドウに表示されます。 |
コメントの追加 | |
コマンドダイアログを開く | コマンドを適用ダイアログを開きます。ここで、課題を更新するコマンドを入力できます。コマンドの完全なリストについては、コマンドリファレンスを参照してください。 |
タスクを開く | 選択した課題をアクティブタスクとして設定します。コードで行ったすべての変更は、現在のタスクとして選択されている課題に関連付けられています。 |
課題リンクをコピー | 選択した課題の URL をクリップボードにコピーします。 |
YouTrack で表示 | 選択した課題を YouTrack で開きます。 |
スタックトレースの分析 | スタックトレースの分析ダイアログの課題の説明からスタックトレースを開きます。 |
課題のピン留め | 選択した課題を別のツールウィンドウタブで開きます。固定された課題を削除するには、ツールウィンドウタブを右クリックしてタブを閉じるを選択します。 |
プレゼンテーションの切り替え | ツールウィンドウの課題のリストを展開および折りたたみます。ツールウィンドウでサポートされる 2 つのビューは、YouTrack の課題リストの 1 行ビューおよびコンパクトビュー設定に似ています。 |
セットアップを開くダイアログ | プラグイン設定ダイアログを開きます。ここでは、YouTrack サーバーの URL を変更したり、永久トークンを更新したり、タイムトラッキング設定を調整したりできます。 |
ヘルプ | プラグインでサポートされている機能について説明している YouTrack サーバーのドキュメントのページを開きます。 |
課題通知を受け取る
プラグインを通じて YouTrack に接続すると、更新通知が IDE に直接配信されます。つまり、メールや外部メッセージングクライアントに切り替えることなく、すべての課題について最新の情報を得ることができます。
IDE に送信される通知は、ユーザープロファイルの通知タブで構成されている個人通知設定に基づいています。詳細については、通知を参照してください。
各通知に対して次のアクションを使用できます。
アクション | 説明 |
---|---|
表示 | YouTrack で通知が送信された課題を開きます。 |
却下 | 通知ポップアップで選択すると、通知バルーンが閉じます。イベントログツールウィンドウで選択すると、通知リンクは無効になります。 |
通知を構成する | YouTrack プロファイルで通知タブを開きます。ここで、一般的な通知スキームを変更し、サブスクリプションを更新できます。 |
これらの通知の外観と動作は、IDE の通知設定によって決まります。これらの設定は、通知をバルーン通知として表示するかどうか、および通知の表示方法を決定します。これらの設定の詳細については、IDE のドキュメントを参照してください。JetBrains IDE の場合、通知設定は IntelliJ IDEA のドキュメントで説明されているオプションに似ています。
リストで課題を検索する
特定の課題を検索するには、ツールウィンドウを選択して入力を開始します。検索クエリに一致する最初の課題がリストでハイライトされます。
IDE のタスクとしての未解決の課題
タスク管理プラグインと同様に、YouTrack 統合プラグインを使用すると、課題をタスクとして開き、現在の作業コンテキストを設定できます。
作業コンテキストを定義するには
YouTrack ツールウィンドウを開きます。
リストから課題を選択します。
タスクを開くアイコンをクリックしてください。
新しいタスクのパラメーターを設定します。
タスク管理では、次のオプションがサポートされています。
オプション
説明
課題の状態を更新
有効にすると、状態タイプを保存するカスタムフィールドの値を、ドロップダウンリストで選択した値に更新します。
現在のコンテキストをクリア
有効にすると、現在のコンテキストがクリアされます。
プロジェクトがバージョン管理システムに接続されている場合は、VCS 操作の一連のオプションも使用できます。これらのオプションはバージョン管理システムによって異なります。Git ベースのバージョン管理システムでは次の操作が可能です。
操作
説明
変更リストの作成
入力フィールドに指定された名前で変更リストを作成します。各変更リストに割り当てられるデフォルト名は、IDE の設定 / 環境設定の セクションで変更リスト名のフォーマットとして定義されます。
このオプションの選択を解除すると、IDE は変更リストを作成せずに、作業コンテキストをタスクに切り替えます。
現在の変更を退避
まだリポジトリにコミットしていない保留中の変更を保存します。その後、前のタスクに戻るときに、延期された変更をアンシェルブできます。
ブランチの作成
入力フィールドに指定された名前でブランチを作成します。各変更リストに割り当てられるデフォルト名は、IDE の設定 / 環境設定の セクションで feature ブランチ名フォーマットとして定義されます。
ブランチを使用
既存のブランチを選択して変更を保存できます。
他の VCS 操作の詳細については、IDE のドキュメントを参照してください。
OK ボタンをクリックしてください。
新しいタスクがあなたの作業コンテキストとして設定されます。
アクティブなタスクは、課題リストで の星アイコンでマークされます。
課題の作成
IDE の課題の解決に取り組んでいるときに、別の課題またはタスクで対処したい他の課題が発生する場合があります。YouTrack 統合プラグインを使用すると、コンソールでコードブロックまたはメッセージをハイライトし、YouTrack の新しい課題の説明フィールドに挿入できます。
YouTrack の課題を作成オプションは、コードエディターのコンテキストメニュー、およびスクリプトを実行するためのツールウィンドウ、デバッグコンソール、イベントログから利用できます。
IDE から新しい YouTrack の課題を作成するには:
新しい号の説明フィールドにコピーするテキストをハイライトします。
コンテキストメニューを開き、YouTrack の課題を作成オプションを選択します。
YouTrack は、新しいブラウザータブで新しい課題ページを開きます。
IDE で選択したテキストのブロックは、課題の説明のフィールド内にフェンスで囲まれたコードブロックとして設定されます。
このアクションは、次のキーボードショートカットにもマップされます。
オペレーティングシステム
ショートカット
Windows/Linux
Ctrl + Shift + Z
macOS
Shift + ⌘ + Z
必要に応じて、課題を報告するプロジェクトを選択します。
課題の概要を入力します。
必要に応じて課題フィールドの初期値を設定します。
作成ボタンをクリックしてください。
新しい課題は YouTrack で作成されます。
コマンドに関する更新の課題
YouTrack 統合プラグインを使用すると、IDE から直接課題にコマンドを適用できます。IDE でコマンドを適用ダイアログを開くには:
ツールバーの YouTrack コマンドを実行するボタンをクリックします。
Ctrl + Shift + Y (macOS では Command + Shift + Y)を押します。
コマンドを適用ダイアログは、YouTrack とまったく同じように機能します。詳細については、コマンドを参照してください。
IDE でスタックトレースを開く
YouTrack は、課題の説明またはコメントに挿入された Java および C# スタックトレースを自動的に認識してフォーマットします。
スタックトレースがフォーマットされると、ソースコードへの参照やその他の課題がリンクとして設定されます。これらのリンクをクリックして、IDE でターゲット参照を開きます。
経過時間の追跡
YouTrack のプロジェクトでタイムトラッキング機能が有効になっている場合は、IDE での作業に費やした時間を追跡し、この情報を作業項目として YouTrack の課題に投稿できます。
タイムトラッキング
ツールウィンドウのタイムトラッキングタブには、YouTrack のさまざまな課題に投稿した作業項目のリストが表示されます。
ツールウィンドウの上部にある検索ボックスを使用して、さまざまな条件を使用してリストをフィルタリングします。
プラグインのツールバーのコントロールを使用すると、リストを発行または日付で並べ替えるかどうかを選択できます。
ツールバーの追加のコントロールは、IDE を使用するときに課題に作業項目を投稿する方法を管理できます。これらのコントロールの可視性は、プラグイン設定での追跡モードオプションの現在の選択に基づいています。
プラグインは、IDE での作業に費やした時間を追跡するための 3 つの異なるモードをサポートしています。使用するモードを選択するには、プラグイン設定ダイアログでタイムトラッキング設定を編集します。
追跡モード: オフ
追跡モードオプションがオフの場合でも、IDE での作業中に、使用した時間を YouTrack の課題に投稿することができます。これは、経過時間を追加ダイアログで手動で作業項目を作成することによって管理されます。このダイアログを開くには、プラグインのツールバーにある対応するアイコンをクリックします。
次のフィールドを使用して、YouTrack の課題に作業項目を手動で追加します。
フィールド | 説明 |
---|---|
経過時間 | 作業項目に追加する時間を時間と分で設定します。 |
課題 | 作業項目を追加する課題を選択します。 IDE の作業コンテキストとして YouTrack の課題がすでに発生している場合は、自動的に選択されます。それ以外の場合は、リストから課題を選択します。リストは、プラグインの課題に現在適用されている検索条件に一致するようにフィルタリングされます。 |
作業タイプ | リストからワークアイテムタイプを選択します。 |
カスタム作業項目の属性 | 必要に応じて、カスタム作業項目属性の値を選択します。 |
コメント | この作業項目によって表されるアクティビティを説明するオプションのコメントを入力します。 |
日付 | 作業が行われた日付を選択します。デフォルトでは、現在の日付が選択されています。 |
追跡モード: マニュアル
時間を追跡するための 2 番目のオプションでは、タイマーを使用して費やした時間を測定できます。
マニュアルモードがアクティブな場合、プラグインのツールバーに次のアクションが追加されます。
アクション | 説明 |
---|---|
作業タイマーの開始 | タイマーを開始して、現在のタスクの作業に費やした時間を追跡します。 クリックすると、このコントロールは作業タイマーの一時停止アクションに切り替わります。 |
作業タイマーの一時停止 | アクティブな課題に費やした時間を投稿せずにタイマーを一時停止します。 クリックすると、このコントロールは作業タイマーの開始アクションに切り替わります。 |
作業タイマーのリセット | アクティブなタスクに対して現在追跡されている時間をクリアし、タイマーを再開します。 |
作業タイマーを停止します | タイマーを停止し、アクティブなタスクに対して現在追跡されている時間を、対応する課題に作業項目として追加します。作業項目のタイプとコメントの値は、プラグインのデフォルト設定から取得されます。 |
追跡された時間を表示する | ローカルに保存された時間エントリのリストを含むダイアログを開きます。使用時間のローカル追跡の詳細については、使用時間のローカル追跡を参照してください。 |
次の設定は、手動モードでも使用できます。
設定 | 説明 |
---|---|
作業タイプ | 作業タイマーを停止しますアクションを使用して転記されるすべての作業項目のデフォルトの作業タイプを設定します。 |
コメント | 作業タイマーを停止しますアクションを使用して投稿されるすべての作業項目のデフォルトのコメントテキストを設定します。 |
追跡モード: 自動
時間を追跡するための最後のオプションでは、プラグインがすべての作業を実行できます。自動モードがアクティブな場合、プラグインのツールバーに次のアクションが追加されます。
アクション | 説明 |
---|---|
作業タイマーの一時停止 | アクティブな課題に費やした時間を投稿せずにタイマーを一時停止します。 クリックすると、このコントロールは作業タイマーの開始アクションに切り替わります。 |
作業タイマーの開始 | 現在のタスクの作業に費やされた時間の追跡を再開します。 クリックすると、このコントロールは作業タイマーの一時停止アクションに切り替わります。 |
サーバーへの投稿時間 | アクティブなタスクに対して現在追跡されている時間をワークアイテムとして対応する課題に追加し、タイマーを再起動します。作業項目タイプとコメントの値は、プラグインのデフォルト設定から取得されます。 |
追跡された時間を表示する | ローカルに保存された時間エントリのリストを含むダイアログを開きます。使用時間のローカル追跡の詳細については、使用時間のローカル追跡を参照してください。 |
自動モードでは、IDE で YouTrack 統合プラグインを使用するように構成されたプロジェクトを開くと、タイマーが自動的に開始します。
プラグインのタイムトラッキング設定の追加オプションにより、その時点からの時間の追跡方法が決まります。これらのオプションは、セットアップダイアログの作業項目を自動的に作成するセクションに表示されます。次のオプションを使用できます。
オプション | 説明 |
---|---|
プロジェクトを閉じるとき | 現在のプロジェクトを閉じるか IDE を終了するたびに、アクティブなタスクに対して追跡された時間を対応する課題に追加します。 |
変更をコミットするとき | 現在の一連の変更をバージョン管理にコミットするたびに、アクティブなタスクに対して追跡された時間を対応する課題に追加します。 |
決められたスケジュール | アクティブなタスクに対して追跡された時間を、毎日指定された時間に対応する課題に自動的に投稿します。 このアクションは、IDE が指定された時間に開いている場合にのみ適用されます。 |
非アクティブ期間設定は、指定された期間 IDE でアクティブに作業していない場合に、作業タイマーを自動的に一時停止するようにプラグインに指示します。タイマーが一時停止している場合、IDE での作業を再開するとすぐに自動的に再起動します。
自動モードの場合、プラグインは IDE でのユーザーのアクティビティを追跡します。これには、マウスの動き、キーストローク、アクティブなウィンドウまたはタブ間のフォーカスの変更が含まれます。プラグインが指定された非アクティブ期間内に IDE のアクティビティを検出できない場合、タイマーは自動的に一時停止されます。
自動モードでは、次の設定も使用できます。
設定 | 説明 |
---|---|
作業タイプ | サーバーへの投稿時間アクションを使用して転記されるすべての作業項目のデフォルトの作業タイプを設定します。 |
コメント | サーバーへの投稿時間アクションを使用して投稿されるすべての作業項目のデフォルトのコメントテキストを設定します。 |
使用時間のローカル追跡
費やした時間を追跡しながらタスクを頻繁に切り替えると、タスクで報告される小さな作業項目が多数表示される場合があります。タスクが乱雑になり、サブスクライバーにスパムが送信されないようにするために、各タスクに費やした時間を累積し、IDE にローカルに保持し、準備ができたら 1 つの作業項目に集計時間を報告できます。
作業タイマーがあり、作業コンテキストを切り替えると、タイマーは自動的に一時停止し、これまでに追跡した時間がローカルに保存されます。プラグインツールバーの追跡された時間を表示するアクションをクリックすると、現地時間のエントリにアクセスできます。
追跡時間ダイアログには、ローカルに保存した時間エントリのリストが表示されます。各エントリには、課題と、これまでに追跡した時間が表示されます。
このダイアログでは、追跡された時間エントリを管理できます。ダイアログで使用できるコントロールは次のとおりです。
オプション | 説明 |
---|---|
すべて選択 | リストのすべての時間エントリを選択します。 |
YouTrack への投稿 | 選択した現地時間エントリを作業項目として YouTrack の対応する課題に転記します。 |
破棄 | 選択した現地時間のエントリを削除します。 |
キャンセル | 変更せずにダイアログを閉じます。 |
作業コンテキストを、すでに時間を追跡しているタスクに切り替えると、ダイアログが表示されます。
既存の時間記録が見つかりましたダイアログが提供する 2 つのオプションがあります。
オプション | 説明 |
---|---|
YouTrack への投稿 | 現在のタスクのタイマーを一時停止し、作業コンテキストを変更します。 既存の時間エントリを作業項目として、新しい作業コンテキストとして設定したタスクに転記します。 新しい作業コンテキストの新しいタイマーを開始します。 |
保存して続行 | 現在のタスクのタイマーを一時停止し、作業コンテキストを変更します。 新しい作業コンテキストのタイマーを再開します。タイマーは、既存の時間エントリに時間を追加し続けます。 |
ネットワーク接続が不安定な場合は、費やした時間のローカル追跡が便利です。追跡された時間を投稿する必要があるときに IDE が接続を失った場合、プラグインはそれをローカルに保存します。IDE が接続を復元すると、追跡した時刻にアクセスして YouTrack に投稿できます。
使用時間のローカル追跡は、自動およびマニュアル追跡モードで使用できます。
関連ページ:
課題ナビゲーション
JetBrains IDE に組み込まれている統合機能は、チェックインコメントの課題 ID パターンを認識する機能です。これらのパターンは認識され、トラッカーの課題への直接リンクに変換されます。変更リストまたはコミットメッセージで課題 ID を指定すると、その ID は YouTrack の課題への直接リンクとして設定されます。この機能は、IntelliJ IDEA、PhpStorm、PyCharm、RubyMine、WebStorm、AppCode、CLion、Rider、MPS でサポートされ...
IDE でスタックトレースを開く
多くの開発チームは YouTrack を使ってアプリケーションのバグを報告し追跡しています。プログラマーやテスターはしばしばこれらのバグを見つけて修正するために例外を分析します。アプリケーションによって例外がスローされた場合、一般的な方法は、現在のスタックトレース(エラーが発生したときのアクティブスタックフレームのレポート)を取得し、課題の原因を突き止めることです。YouTrack でスタックトレースを操作するために使用できるトリックがいくつかあります。テスターは、課題を報告するときにスタックト...
永久トークンの管理
YouTrack クラウドでは、永久トークンにより、開発者は OAuth 2.0 認証フローを実装しなくても、スクリプトとアプリケーションで RESTAPI 呼び出しを使用して安全に操作にアクセスして実行できます。永久トークンは、ユーザーアカウントに付与されたアクセス許可を持つサービスへのアクセスを許可します。このページでは、ユーザープロファイルで実行される永久トークンを使用した操作について説明します。永久トークンを使用した RESTAPI 呼び出しのサンプルについては、永久トークン認証を参照し...
コマンドリファレンス
コマンドは基本的に、1 つ以上の課題に変更を一度に適用する一連の属性と値のペアです。多くの場合、属性をスキップして、適用する値を入力できます。YouTrack は、指定された値を使用する属性を検出し、コマンドの有効なオプションを提案します。コマンドの入力に使用する形式は、検索クエリで使用する構文と似ています。ただし、コロン、中括弧、シャープシンボルの使用規則はコマンドには適用されません。例: 自分に割り当てられ、タグ YouTrack モバイルに関連付けられている重要な課題を検索するには、次の検索ク...
通知
YouTrack を使用すると、個人の通知スキームをカスタマイズできます。特定の通知チャネルを有効または無効にし、通知を受け取りたい変更を選択できます。これらの設定にアクセスするには、アバターをクリックし、プロファイルリンクを選択してから、通知タブを選択します。一般的な通知スキーム:このタブの最初のセクションには、通知スキームの構成に使用できる一般設定が記載されています。通知を以下に送信:設定では、通知の受信に使用するチャネルを選択できます。次のオプションが利用可能です。メールユーザーアカウン...
通知
IDE に重要なイベントや提案があると、IntelliJ IDEA の右下隅にポップアップする通知バルーンが表示されます。通知ツールウィンドウですべての通知とイベントにアクセスすることもできます。IntelliJ IDEA では、イベントのすべてのグループの通知設定を個別に構成できます。例: すべての VCS 通知を無効にするか、サウンド通知を有効にして、アプリケーションがビルドされたことを知らせることができます。イベントグループごとに通知を構成するを押して IDE 設定を開き、を選択します。通...