GitHub のコミット、pull request、および issue を Azure Boards の作業項目にリンクする

  • [アーティクル]

Azure DevOps Services | Azure DevOps Server 2022 - Azure DevOps Server 2019

Azure Boards プロジェクトと GitHub リポジトリを接続したら、作業項目を GitHub のコミットや pull request とリンクできます。 GitHub ユーザーにはおなじみの #mention 構文を使ったリンクの追加や、Azure Boards の作業項目からの GitHub コミットまたは GitHub pull request のリンクの種類の追加ができます。

Note

GitHub 用の Azure Boards アプリを使用すると、Azure Boards と Azure DevOps Services が、GitHub.com および GitHub Enterprise Server リポジトリとの統合をサポートします。 Azure DevOps Server 2019 以降のバージョンでは、GitHub Enterprise Server リポジトリとの統合のみがサポートされています。他の Git リポジトリとの統合はサポートされていません。

前提条件

  • Azure Boards プロジェクトは、リンク先またはリンク元のコミットと pull request が存在する GitHub リポジトリに接続されている必要があります。 詳細については、「Azure Boards - GitHub 統合」を参照してください。
  • Azure Boards プロジェクトと GitHub リポジトリの共同作成者である必要があります。

注意

ホストされた XML プロセス モデルを使うプロジェクトでは、開発セクションと GitHub リンクの種類を表示する作業項目の種類を更新する必要があります。 詳細については、選択した作業項目の種類に対する XML 定義の更新に関する記事を参照してください。

GitHub のコミット、pull request、または issue から Azure Boards 作業項目へのリンクを作成するには、次の構文を使います。 コミット メッセージのテキスト内に AB#ID を入力します。 pull request や issue の場合は、タイトルか説明 (コメントではない) 内に AB#ID を入力します。

注意

GitHub issue へのリンクには、Azure DevOps Server 2019 Update 1 以降のバージョンが必要です。

AB#{ID}

たとえば、AB#125 は作業項目 ID 125 にリンクします。

コミットまたは pull request メッセージを入力して、作業項目を切り替えることもできます。 システムは fix, fixes, fixed を認識し、それを後続する # メンション項目に適用します。 メンションされた作業項目は、"解決済み" ワークフロー カテゴリ状態に関連付けられた最初の状態に遷移します。 "解決済み" に関連付けられた状態がない場合、"完了" ワークフロー カテゴリ状態に関連付けられた状態に遷移します。 ワークフローの状態とカテゴリの状態がどのようにマップされるかについては、「ワークフロー カテゴリの状態が Azure Boards のバックログとボードでどのように使用されるか」を参照してください。

例については、次の表を参照してください。

コミットまたは pull request メッセージ アクション
Fixed AB#123 "解決済み" ワークフロー状態カテゴリか、何も定義されていない場合は "完了" ワークフロー状態カテゴリに作業項目をリンクし、切り替えます。
Adds a new feature, fixes AB#123. "解決済み" ワークフロー状態カテゴリか、何も定義されていない場合は "完了" ワークフロー状態カテゴリに作業項目をリンクし、切り替えます。
Fixes AB#123, AB#124, and AB#126 Azure Boards 作業項目 123、124、126 へのリンク。 最初の項目 123 のみを "解決済み" ワークフロー状態カテゴリか、何も定義されていない場合は "完了" ワークフロー状態カテゴリに切り替えます。
Fixes AB#123, Fixes AB#124, Fixes AB#125 Azure Boards 作業項目 123、124、126 へのリンク。 すべての項目を "解決済み" ワークフロー状態カテゴリか、何も定義されていない場合は "完了" ワークフロー状態カテゴリのいずれかに切り替えます。
Fixing multiple bugs: issue #123 and user story AB#234 GitHub issue 123 と Azure Boards 作業項目 234 にリンクします。 切り替えは行われません。

Note

2 つ以上の Azure DevOps 組織に定義されているプロジェクトに同じ GitHub リポジトリを接続した場合、予期しない AB# メンション リンクになる可能性があります。 詳細については、「接続の問題を解決する」を参照してください。 このため、1 つの Azure DevOps 組織で定義されたプロジェクトにのみ GitHub リポジトリを接続することをお勧めします。

注意

GitHub issue へのリンクには、Azure DevOps Server 2019 Update 1 以降のバージョンが必要です。

  1. コミットまたは pull request にリンクするには、作業項目を開き、[開発] セクションの [リンクの追加] を選びます。

    Screenshot of work item form, Development section, Add link option.

    issue にリンクするには、[リンク] タブを選び、[リンクの追加]>[既存の項目] を選びます。

    Screenshot of work item form, Links tab, Add link to issue.

  2. [リンクの追加] ダイアログで GitHub のリンクの種類のいずれかを選び、コミット、pull request、または issue の URL を入力して [OK] を選びます。
    ここでは、GitHub pull request へのリンクを追加します。

    Screenshot of work item form, Links tab, Add link dialog, GitHub pull request link type selected.

    Azure Boards では、有効なリンクが入力されたかどうかの検査を完了します。 リンク先の GitHub リポジトリは Azure Boards プロジェクトに接続されている必要があります。そうでない場合、検証は失敗します。

    ここでは、GitHub issue へのリンクを追加します。

    Screenshot of work item form, Links tab, Add link dialog, GitHub issue link type selected.

Note

Azure DevOps Server と GitHub Enterprise Server を使っている場合、AB# リンクを完了する際に遅延が発生します。 Commit、PR、Issue の増分変更を 1 時間ごとに GitHub イベントからプルする「プッシュ アンド プル」設計が採用されています。

作業項目フォーム内の [開発] セクションには、GitHub のコミットと pull request に対して作成されたリンクが GitHub アイコンと共に一覧表示されます。

Screenshot of work item form, Development section shows GitHub links.

表示されたリンクを選ぶと、GitHub のコミットか pull request が開きます。

かんばんボードで GitHub オブジェクトを表示する

かんばんボードで GitHub の注釈を有効にすると、リンクされた GitHub のコミット、pull request、または issue の詳細をすばやく開くことができます。 詳細については、「カードのカスタマイズ」を参照してください。

Screenshot of Kanban board that shows GitHub links on work item cards.

Note

GitHub の注釈を使用するには、Azure DevOps Server 2019 更新プログラム 1 以降のバージョンが必要です。

次のステップ

状態バッジの構成