VS Code での Jira 作業項目
Atlassian for VS Code は Atlassian Labs プロジェクトとして公開されています。Atlassian Labs アプリにはユニークで便利な機能がありますが、Atlassian はお客様によるこれらのアプリの使用について責任を負いません。
VS Code で Jira 作業項目を作成する
Atlassian for VS Code 拡張機能から Jira 作業項目を作成するには、いくつかの方法があります。
コード内リンクの使用
拡張機能は、構成可能なキーワードからトリガーされる作業項目を作成するためのコード内リンクを提供します。 既定では、拡張機能には次のキーワードが構成済みです。TODO、BUG、FIXME、WORK ITEMS。
手順を確認
コード内リンクを追加する行を選択します。
コード内リンクを追加し、いくつかのコンテキストを提供します。例:
// TODO: this needs to be fixed.インライン コードの後に提供したメッセージは、Jira 作業項目の件名になります。拡張機能から、Jira 作業項目を作成するように求められます。ステップ 2 で追加した行の上に表示される [Jira 作業項目を作成] を選択します。
[作業項目の作成] フォームの任意のフィールドに入力または更新します。
[送信] を選択します。
作業項目を作成すると、コメントは、作業項目に関する情報を表示するよう置き換えられます。
これらのトリガーは [Atlassian Settings] 画面で構成できます。
VS Code のコンテキストから作業項目を作成
Jira 作業項目を作成する別の方法として、コード内の任意の場所で右クリックし、コンテキスト メニューを使用できます。これにより、作業項目の作成画面が表示されるだけでなく、Bitbucket のソース コードへのリンク、クリックされた正確な行が、作業項目の説明フィールドに含まれます。複数の行を強調表示すると、リンクには選択した行の範囲が含まれます。
手順を確認
行で右クリックするか、複数の行をハイライト表示して選択した行範囲で右クリックすると、右クリック コンテキスト メニューが開きます。
メニュー項目のリストから [ Create New Jira work item (新しい作業項目を作成 )] を選択します。選択した行は、 新しい Jira 作業項目の説明 フィールドに表示されます。
[作業項目の作成] フォームの任意のフィールドに入力または更新します。
[送信] を選択します。
Bitbucket ではなく別のソース管理システム (Github など) を使用している場合、その行番号の範囲の相対パスが説明フィールドに追加されます。
VS Code から手動で作業項目を作成
コード行に関連付けずに作業項目を作成することもできます。
手順を確認
コマンド パレットから
コマンド パレットを開くには、次の Atlassian: Open Settings コマンドを実行します: Command+ Shift + P (Mac の場合) または Ctrl + Shift + P (PC の場合) を実行し、「Create New Jira Work item」を検索します。
コマンド パレットから、[新しい Jira 作業項目を作成] コマンドを選択します。
[作業項目の作成] フォームの任意のフィールドに入力または更新します。
[送信] を選択します。
Jira 作業項目ツリーから
左端のナビゲーション バーにあるアトラシアンのロゴを選択します。
[アトラシアン] ステータス バーの[JIRA 作業項目] 見出しを選択します。
[+] を選択すると、新しい「作業項目を作成」フォームが開きます。
[作業項目の作成] フォームの任意のフィールドに入力または更新します。
[送信] を選択します。
VS Code の [作業項目の作成] 画面
Atlassian for VS Code は、多くの一般的な Jira フィールドをサポートします。しかしながら、さまざまな Jira プラグインによって提供された複雑なカスタム フィールドのなかには、VS Code ではレンダリングできないものもあります。
作業項目タイプにレンダリングできないフィールドが含まれている場合は、次の 2 つのいずれかが行われます。
フィールドが必須ではない場合、フィールドは表示されません。
フィールドが必須 の場合、 作業項目タイプ はオプションから完全に削除されます。
Created with Sketch.
作業項目の作成後、概要および説明フィールドは空白にリセットされ、その他のすべてのフィールドは以前に選択されたオプションのままになります。これにより、Jira 自体の [さらに作成] オプションと同様に、複数の作業項目をすばやく作成することができます。
これは、プランニング セッションの実施中に同様のフィールド値で多数の作業項目を作成する必要がある場合などに便利です。
Jira 作業項目の表示と変更
VS Code 内で Jira 作業項目の詳細を開いたり更新したりするための複数の方法について紹介します。
手順を確認
作業項目ツリーから作業項目を選択する
作業項目ツリーで作業項目のリストを閲覧している場合は、作業項目を選択するだけで、その作業項目の詳細画面が表示されます。
Command Palette を使用する
開きたい作業項目のキーを確認済みの場合、コマンド パレットから詳細画面をすばやく開くことができます。
コマンド パレットを開くには、次の [Atlassian: Open Settings] コマンドを実行します: Command + Shift + P (Mac の場合) または Ctrl + Shift + P (PC の場合) を実行。
「open Jira work item」を検索し、[Atlassian: Open Jira Work item] を選択します。
入力ボックスが表示されるので、作業項目キーを入力して Enter キーを押すと詳細が表示されます。
作業項目のホバー
拡張機能には、作業項目のホバーのサポートが含まれます。
コード内の任意の場所 (通常はコードのコメント内) で作業項目キーにカーソルを合わせると、作業項目のクイック ビューのモーダルが表示されます。
モーダル内で、[ 作業項目ビューを開く ] リンクをクリックして、作業項目の詳細画面全体を開きます。
作業項目のポップアップは、[アトラシアン設定] 画面で無効化 / 有効化できます。
Jira 作業項目での作業を開始
作用項目での作業を開始機能は、コーディングを開始できるよう、Jira および Bitbucket で必要なすべての手順を実行します。
この機能の使用を始める前に、次の点を確認します。
作業項目を自分自身に割り当てる
作業項目の新しいブランチを作成し、作業項目のキーとブランチ名を含める
新しいブランチをローカルにチェックアウトし、それをリモート リポジトリ ブランチにリンクする
作業項目を「進行中」にトランジションする
この機能を使用するには、次の手順を実行します。
アトラシアン ステータス バーにある [ オープンな作業項目 ] リストから、作業を開始するオープンな作業項目をダブルクリックします。
[作用項目での作業を開始] ボタンをクリックして作業項目にアクセスします。
[作用項目での作業を開始] ボタンを選択すると、次のようになります。
作業項目が自分に割り当てられる
作業項目が選択したステータスにトランジションされる
名前に作業項目キーを含むブランチが作成される
ブランチがローカルにチェックアウトされます。
ブランチのアップストリームがリモート ブランチに設定されます。
When you put a work item key in your branch name you can see and interact with work items similar to the way you would in Jira within the Bitbucket Cloud interface. Learn more
すべてのコミット メッセージに作業項目キーを追加することもおすすめです。これらは Bitbucket インターフェイスで自動的にリンクされるだけでなく、VS Code 拡張機能がコミットやプル リクエストに関連する作業項目を見つけるのにも役立ちます。
今後は作業項目キーを忘れない
アトラシアンでは、Jira 作業項目キーを、キーを入力したり、記憶しなくても、簡単にコミット メッセージに含めることができるようにしました。ブランチ名に作業項目キーを付けるブランチを作成する場合、git prepare-commit スクリプトを使用することで、ブランチ名の作業項目キーをすべてのコミット コメントに自動的に追加できます。
prepare-commit スクリプトの作成方法が不明な場合、以下をご覧ください。
bitbucket.org/snippets/atlassian/qedp7d/...
この内容はお役に立ちましたか?