PhpStorm 2024.3 ヘルプ

Git と課題トラッカーの統合

PhpStorm を使用すると、コミットメッセージをバグトラッカーまたは課題データベースに接続し、VCS ログ内のコミットからこれらのコミットに関連する課題に移動できます。

  1. Ctrl+Alt+S を押して設定を開き、バージョン管理 | 課題ナビゲーションを選択します。

  2. このダイアログを使用して、課題ナビゲーションパターンのリストを作成します。

    Issue navigation settings

    課題ナビゲーションパターンは、コミットメッセージ内の課題 ID パターンを、参照される課題の URL アドレスにマップします。これにより、コミットされた変更からそれらの変更に関連する課題に移動できるようになります。PhpStorm がコミットメッセージ内の課題 ID パターンとの一致を検出すると、その一致はバージョン管理ツールウィンドウ Alt+9 にリンクとして表示されます。いくつかの課題についてメンションすると、それらすべてがリンクとして表示されます。このようなリンクをクリックすると、デフォルトのブラウザーでマッチングの課題が開きます。

    課題ナビゲーション設定では、課題は課題のパターンを示す読み取り専用フィールドです。リンクは、現在の行の課題パターンからバグ追跡システムの課題に移動するためのリンクを示す読み取り専用フィールドです。

    追加」をクリックして、コミットメッセージ内の課題パターンを参照される課題の URL アドレスにマッピングすることで、課題ナビゲーションパターンのリストを構成します。

    • JIRA(英語) または YouTrack を使用している場合は、ツールバーの JIRA パターンの追加または YouTrack パターンの追加をクリックし、バグ追跡システムのインストール先の URL を入力します。

      PhpStorm は、ナビゲーションパターンを定義する正規表現を自動的に追加します。

    • 他の課題追跡システムの場合は、「課題ナビゲーションリンクを追加」をクリックして新しいエントリを作成するか、「 編集」をクリックして既存のエントリを編集します。開いたダイアログで、次の正規表現を指定します。

サンプル

以下の例は、PhpStorm が前述のルールを適用して、コミットメッセージ内の課題への参照を検出し、課題追跡システムでその課題へのリンクを作成する方法を示しています。

Add Issue Navigation Link dialog

課題 ID

コミットメッセージ内の課題参照の形式を定義する正規表現

[A-Z]+\-\d+

この正規表現は、n- ダッシュ文字で区切られた 2 つの部分文字列で構成されるすべての文字列に一致します。

  1. 部分文字列 1: 無制限の数の大文字アルファベット。

  2. 部分文字列 2: 無制限のデジタル文字。

課題追跡システムの URL アドレスとその課題を識別する正規表現の組み合わせ。

http://<mytracker>/issue/$0

ここで $0 はマッチ全体への後方参照を示します。これは、PhpStorm がコミットメッセージで一致を検出するとすぐに、それがそのままトラッカーの URL アドレスに追加されることを意味します。

一致する発行 ID

PhpStorm は、関心のあるコミットメッセージ内の課題に対する以下の参照を検出します。

MYPROJECT-110

構成された課題のリンク

上記の課題のナビゲーションパターンに従って、検出された照合参照はそのままトラッカーの URL に追加されるため、参照された課題へのリンクは次のように構成されます。

http://mytracker/issue/MYPROJECT-110