將 GitHub 提交、拉取請求、分支和問題連結到 Azure Boards 中的工作項目

Azure DevOps 服務 |Azure DevOps Server |Azure DevOps Server 2022

本文將說明在您將 Azure Boards 專案連線至 GitHub 存放庫之後，如何將工作項目連結至 GitHub 提交、提取要求、分支和組建。 使用 #mention 語法來處理提交與分支，使用!提及來參考工作項目討論中的 GitHub 拉取請求，或直接從Azure Boards工作項目新增GitHub提交、拉取請求或分支連結。

Prerequisites

使用 AB# 將 GitHub 連結到 Azure Boards 工作項目

使用 GitHub 文字中的 AB# 提及來連結至 Azure Boards 工作項目。

建立連結：

1. 將 AB#{ID} 加入到提交訊息、提取要求描述或議題描述中。
2. 推送 commit，或儲存提取要求或問題。
3. 打開工作項目以確認連結是否出現在 開發 區塊。

在留言或提取要求標題中使用 AB#ID，並不會在工作項目上建立連結。

AB#{ID}

例如，AB#125 鏈接到工作項目 ID 125。

你也可以透過提交或提取要求中的文字來變更工作項目的狀態。 Azure Boards 會識別 {state} 或 {state category} 以及例如 fix、fixes 和 fixed 等關鍵字，然後將該狀態轉換套用至後面接著的 AB# 參照。

例如，當提取要求描述包含有效的狀態名稱時， Closed AB#1234系統會將參考的工作專案更新為該特定狀態。 如果狀態名稱無法直接辨識，Azure Boards會嘗試將其匹配到像是 Resolved 或 Completed 這類工作流程類別。 如果找到相符專案，工作專案就會轉換為該類別下定義的第一個可用狀態。

預設情況下，參考了 fix、fixes、或 fixed 的工作項目將過渡到與 已解決 類別相關的第一個狀態。 如果目前進程中沒有這類狀態，系統會改為將工作項目轉換為 [已完成 ] 類別中的第一個狀態。

欲了解更多資訊，請參閱 工作流程類別狀態如何在Azure Boards待辦清單與板上使用。

請使用以下僅連結的範例：

請使用以下連結與轉換的範例：

當你在拉取請求描述中使用 加入工作項目連結時，這些連結會出現在 GitHub 拉取請求的 Development 區塊中。 只有在拉取請求描述中使用 AB# 時，這些連結才會可用。 如果你從工作項目直接鏈接到拉取請求，它們就不會顯示。 從描述中移除 AB# 該參考，也會從開發區塊中移除。

從工作項目建立 GitHub 分支

要直接從工作項目建立 GitHub 分支，請使用以下步驟：

1. 從你的看板上找到你想用來建立 GitHub 分支的工作項目。

2. 選擇 工作項目操作>新建 GitHub 分支。

   

3. 在 Create a GitHub branch 對話框中，輸入分支名稱。 選擇 GitHub 倉庫和基礎分支。

4. 選取 ，創建。

   

   Azure Boards 會在指定的 GitHub 倉庫建立分支，並將其連結到工作項目。 更多資訊請參見Azure Boards-GitHub整合。

將工作項目連結新增至 GitHub 分支、提交或拉取要求

1. 打開你的工作項目，進入 開發 區。

2. 選擇 新增連結。 在每個下拉選單中，選擇你的 link 類型、GitHub repository，以及 GitHub pull request。 你可以在儲存庫中搜尋並深入挖掘，找到並選擇特定的拉取請求或提交，無需複製貼上網址。

3. 選擇 新增連結。

   

   Azure Boards 會檢查你是否輸入了有效的連結。 連結的GitHub倉庫必須連接到Azure Boards專案，否則驗證失敗。

自動連結更新

有幾個事件會自動更新工作項目表單上的連結，所以你不需要手動建立連結。 這些活動包括：

從開發區段檢視或開啟連結

工作項目表單中的開發區塊列出了使用 GitHub 圖示建立的連結，以GitHub提交與拉取請求。

選擇連結以開啟 GitHub 中的提交或拉取請求。

GitHub 拉取請求分析

開發區塊的連結 GitHub 拉取請求會顯示額外的狀態細節。 你可以在 GitHub 上不打開 pull request 的情況下評估進度。

拉取請求洞察的前提條件

想查看拉取請求的深入資訊，請進入 GitHub 中的 Azure Boards 應用程式，並接受更新後的檢查讀寫權限。

查看拉取請求狀態細節

1. 打開一個有連結 GitHub 拉取請求的工作項目。

2. 在 開發 區塊，找到連結的拉取請求。 以下狀態資訊顯示在拉取請求連結旁：

   • 草稿狀態：顯示該拉取請求是否仍為草稿。
   • 審查狀態：顯示拉取請求是否需要審查、是否已核准或是否有變更請求。
   • 檢查狀態：顯示 CI 檢查是否通過、失敗或待處理。

   

3. 將滑鼠移到狀態指示器上可以看到更多細節，或選擇拉取請求連結直接在 GitHub 開啟。

使用 ! 來提及GitHub拉取請求

使用 ! 提及功能，直接在任何工作項目的富文本欄位或討論評論中參考並討論 GitHub 拉取請求。 當你在文字欄位輸入 ! 時，會出現一個選擇器，你可以用它來搜尋並選擇連接的資料庫中的 GitHub 拉取請求。 選取的拉取請求會以可點擊連結的形式插入。

此功能讓您能輕鬆在工作項目描述、接受標準或討論串中引用相關拉取請求，而無需手動複製網址。

查看 YAML 管線的建置狀態（內建於建置中）

當你使用 Azure Pipelines YAML 來建立託管在 GitHub 倉庫的程式碼時，你可以自動建立相關的工作項目上的 Integrated in build 連結。 此功能為 GitHub 倉庫提供建置可追溯性，與 Azure Repos 的體驗相當。

若要啟用此功能：

1. 打開你的 YAML 管線，選擇 更多動作，然後選擇 設定。

2. 在 管線設定 對話框中，啟用 「自動連結此建置中的新工作項目」。

   

建置完成後，每個相關工作項目的開發區會自動顯示「整合於建構」連結，讓你的團隊能完整追蹤從工作項目到建置。

欲了解更多關於設定此設定的資訊，請參閱 「配置管線以支援工作追蹤」。

在板子上檢視 GitHub 物件

當你在看板上啟用 GitHub 註解時，可以快速打開連結的 GitHub 提交、拉取請求或議題，了解更多細節。 如需詳細資訊，請參閱 自定義卡片。

使用 AI 來連結和管理 GitHub 工作

如果你設定 Azure DevOps MCP 伺服器，可以用自然語言描述 GitHub 與工作項目的連結任務，而不必手動瀏覽工作項目表單。

把這些提示當作情境範例。 支援的操作會依照所配置的工具組、擴充套件版本以及你的權限而有所不同。

有些提示可能會回傳指引而不是執行寫入動作，或者根據你啟用的 MCP 工具，可能需要多個提示。

在執行提示之前，請先將例如 <Contoso>、<owner/repo> 和 <sha> 這類預留位置替換為你的實際值。

請使用這個快速的執行與驗證流程：

1. 執行表格中的一則提示詞。
2. 檢視回應以了解所採取的行動。
3. 打開工作項目，並在 開發 區塊確認結果。
4. 打開相關的 GitHub 文件，確認預期的連結或更新。

先試試這些提示：

• Link work item AB#125 in project <Contoso> to GitHub pull request <owner/repo>#42
• Link work item AB#312 in project <Contoso> to GitHub commit <owner/repo>@<sha>
• Summarize all GitHub commits and pull requests linked to work item AB#312 in project <Contoso>

AI 輔助連結功能疑難排解

• 如果提示沒有執行，請確認你的 AI 客戶端是否啟用了代理模式。
• 如果提示錯誤且存取錯誤，請確認你的帳號是否能存取 Azure DevOps 專案和 GitHub 倉庫。
• 如果沒有建立連結，請將所有佔位符（例如 <Contoso>、 <owner/repo>、 <sha>）替換成實際值，然後重新執行提示。
• 如果批次提示失敗，先用單一工作項目重試，然後用較小的批次重複。
• 如果結果仍不符合預期，請在工作項目開發區塊及相關的 GitHub 產物中驗證結果。

下一個步驟

相關內容

• 將Azure Boards整合到GitHub
• 設定管線以支援工作追蹤
• 了解工作流程類別狀態如何在Azure Boards待辦清單和板子中使用
• 將工作專案連結至物件
• 解決 GitHub 與 Azure Boards 連線問題