VS Code での Jira 課題
VS Code で Jira 課題を作成する
Atlassian for VS Code 拡張機能から Jira の課題を作成するには、いくつかの方法があります。
コード内リンクの使用
拡張機能は、構成可能なキーワードからトリガーして課題を作成できる、コード内リンクを提供します。既定では、拡張機能では次のキーワードが構成済みです。TODO、BUG、FIXME、および ISSUE。
- コード内リンクを追加する行をクリックします。
- コード内リンクを追加し、いくつかのコンテキストを提供します。例:
// TODO: this needs to be fixed.インライン コードの後に提供したメッセージは、Jira 課題の件名になります。 - 拡張機能から、Jira 課題を作成するように求められます。ステップ 2 で追加した行の上に表示される [Create Jira issue] をクリックします。
- [Create Issue] フォームの任意のフィールドを入力または更新します。
- 送信をクリックします。
課題を作成すると、コメントは、課題に関する情報を表示するために置き換えられます。
これらのトリガーは [Atlassian Settings] 画面で構成できます。
VS Code のコンテキストから課題を作成
課題を作成する別の方法として、コード内の任意の場所で右クリックし、コンテキスト メニューを使用できます。これにより、課題の作成画面が表示されるだけでなく、Bitbucket のソース コードへのリンク、クリックされた正確な行が、課題の説明フィールドに含まれます。複数の行を強調表示すると、リンクには選択した行の範囲が含まれます。
- 行で右クリックするか、複数の行をハイライト表示して選択した行範囲で右クリックすると、右クリック コンテキスト メニューが開きます。
- メニュー アイテムの一覧から [Create New Jira issue] を選択します。選択した行は、新しい Jira 課題の [説明] フィールドに表示されます。
- [Create Issue] フォームの任意のフィールドを入力または更新します。
- 送信をクリックします。
Bitbucket ではなく別のソース管理システム (Github など) を使用している場合、その行番号の範囲の相対パスが説明フィールドに追加されます。
VS Code から手動で課題を作成
コード行に関連付けずに課題を作成することもできます。
VS Code の課題の作成画面
Atlassian for VS Code は、多くの一般的な Jira フィールドをサポートします。しかしながら、さまざまな Jira プラグインによって提供された複雑なカスタム フィールドのなかには、VS Code ではレンダリングできないものもあります。
課題タイプにレンダリングできないフィールドが含まれている場合は、次の 2 つのいずれかが行われます。
フィールドが必須ではない場合、フィールドは表示されません。
フィールドが必須の場合、課題タイプがオプションから完全に削除されます。
課題の作成後、概要および説明フィールドは空白にリセットされ、その他のすべてのフィールドは以前に選択されたオプションのままになります。これにより、Jira 自体の [さらに作成] オプションと同様に、複数の課題をすばやく作成することができます。
これは、プランニング セッションの実施中に同様のフィールド値で多数の課題を作成する必要がある場合などに便利です。
Jira 課題の表示と変更
VS Code 内で Jira 課題の詳細を開いたり更新したりするための複数の方法について紹介します。
課題ツリーで課題をクリックします
課題ツリーで課題の一覧を閲覧している場合、課題をクリックすると、課題の詳細画面が表示されます。
Command Palette を使用する
開きたい課題のキーを確認済みの場合、コマンド パレットから詳細画面をすばやく開くことができます。
- コマンド パレットを開くには、次の [Atlassian: Open Settings] コマンドを実行します: Command+ Shift + P (Mac の場合) または Ctrl + Shift + P (PC の場合) を実行。
- 「open Jira issue」と入力を開始し、[Atlassian: Open Jira Issue] を選択します。
入力ボックスが表示され、課題キーを入力して Enter キーを押すと詳細が表示されます。
マウスオーバーでの課題表示
拡張機能には、マウスオーバーによる課題の表示のサポートが含まれます。
- コード内の任意の場所 (通常はコードのコメント内) で課題キーにカーソルを合わせると、課題のクイック ビューのモーダルが表示されます。
- モーダルで [Open Issue View] リンクをクリックすると、課題の完全な詳細画面が開きます。
課題のモーダル表示は、[Atlassian Settings] 画面で無効化 / 有効化できます。
Jira 課題での作業を開始
Start work on issue 機能は、コーディングを開始できるよう、Jira および Bitbucket で必要なすべての手順を実行します。
この機能の使用を始める前に、次の点を確認します。
課題を自身に割り当てる
課題の新しいブランチを作成し、課題のキーとブランチ名を含める
新しいブランチをローカルにチェックアウトし、それをリモート リポジトリ ブランチにリンクする
課題を "In progress" にトランジションする
この機能を使用するには、次の手順を実行します。
- Atlassian ステータス バーにある [Open Issues] リストから、作業を開始するオープンな課題をダブルクリックします。
- [Start work on an issue] ボタンをクリックして課題にアクセスします。
[Start work on an issue] ボタンを選択すると、次のようになります。
- 課題が自身に割り当てられます。
- 課題が選択したステータスにトランジションされます。
- 名前に課題キーを含むブランチが作成されます。
- ブランチがローカルにチェックアウトされます。
- ブランチのアップストリームがリモート ブランチに設定されます。
ブランチ名に課題キーを追加すると、Bitbucket Cloud インターフェイスで Jira Software を扱うのと似た方法で、課題を表示したり操作したりすることができます。詳細情報
すべてのコミット メッセージに課題キーを追加することもおすすめです。これらは Bitbucket インターフェイスで自動的にリンクされるだけでなく、VS Code 拡張機能がコミットやプル リクエストに関連する課題を見つけるのにも役立ちます。
課題キーを簡単に取得
アトラシアンでは、Jira 課題のキーを、キーを入力したり、記憶しなくても、簡単にコミット メッセージに含めることができるようにしました。課題キーをブランチ名に持つブランチを作成する場合、git prepare-commit スクリプトを使用することで、すべてのコミット コメントにブランチ名の課題キーを自動的に追加できます。
prepare-commit スクリプトの作成方法が不明な場合、以下をご覧ください。