共用方式為


連結類型的參考指南

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

使用不同的連結類型來管理工作專案與其他工件之間的關聯性,例如組建、提交和拉取請求。 本文說明下列連結類型。

特定欄位會維護前四個連結類型的連結計數,例如 相關連結計數超連結計數外部連結計數遠端連結計數

  • 工作連結類型:連結工作專案,包括選取測試案例管理工作專案
  • 超連結:將工作項目連線至任何URL或網路共用
  • 外部連結類型:將工作專案連接到外部物件,例如程式代碼對象、組建或Wiki頁面
  • GitHub 連結類型:將工作項目連線至 GitHub 存放庫認可或提取要求。

特定欄位會維護前三個連結類型的連結計數,例如 相關連結計數超連結計數外部連結計數

鏈結類型具有拓蹼限制。 使用下表中的指引,根據您計劃建立的查詢和報告來選擇連結類型。 若要進一步瞭解拓蹼,請參閱 鏈結類型拓蹼和限制

工作連結類型為系統定義、進程定義或使用者定義(自定義)。 下表所列的連結是系統定義的。

每一個工作鏈結類型都會定義您在工作項目之間建構鏈結時所使用的標籤、拓蹼及限制。 例如,父子連結類型會定義兩個標籤:Parent 和 Child。 連結類型會使用樹狀拓撲結構,並防止工作專案之間的循環參考。

螢幕擷取畫面,顯示工作專案連結類型的概念圖。

工作專案的 相關連結計數 等於使用工作連結類型定義的所有連結總和。

下表描述您可以使用WorkItemLinksFilter XML 元素來限定連結控制範圍的工作項目連結類型。

名稱

參考名稱

使用方式


產生影響-受到影響 (僅限 CMMI) 螢幕截圖,顯示 [產生影響] 連結類型的概念圖。螢幕截圖,顯示 [受到影響] 連結類型的概念圖。

Microsoft.VSTS.Common.Affects-Forward
Microsoft.VSTS.Common.Affects-Reverse
拓撲類型:相依性
鏈接類別:進程定義

使用此方向連結來建立工作專案之間的連結,而不建立封閉迴圈。 人們通常使用它來追蹤與需求相關的變更請求。

限制和建議:

  • 使用「影響」將變更請求僅連結至一個需求。 使用「受影響」功能,將需求連結至所需的子項變更要求。
  • 只使用 Affects-Affected 連結來連結相同專案中的工作項目。 當您計劃使用 Excel 來修改或更新工作專案數據時,建議您這樣做。

Child-Parent
螢幕擷取畫面,顯示子連結類型的概念圖。
螢幕擷取畫面,顯示父連結類型的概念圖。

System.LinkTypes.Hierarchy-Forward
System.LinkTypes.Hierarchy-Reverse
拓撲類型:樹狀結構
鏈接類別:系統定義

使用此方向連結可在單一父項與一或多個子項之間建立一對多關聯性。 使用它來組織階層內的工作專案。 您可以使用 對應函式 在待辦專案之間建立此階層,或使用 短期衝刺待辦專案工作面板在待辦專案和工作之間建立此階層。

一般用法包括:

  • 維護任務與摘要的關係。 父子鏈結代表概要任務及其附屬任務。
  • 將工作連結至 PBIs、用戶劇本或需求。 支援待辦專案概觀、劇本概觀和需求概觀報告。

限制和建議:

  • 使用 Excel 大量編輯工作項目和父子連結。 參見 使用 Excel 大量新增或修改工作專案
  • 工作專案只能有一個 Parent。 父工作項目可以有許多子項目。
  • 只使用父子連結來連結相同專案中的工件。 當您計劃使用 Excel 來修改或更新工作專案數據時,建議您這樣做。

Duplicate-Duplicate螢幕擷取畫面 ,顯示 重複連結類型的概念圖。螢幕擷取畫面,顯示 [重複] 連結類型的概念圖。

System.LinkTypes.Duplicate-Forward
System.LinkTypes.Duplicate-Reverse
拓撲類型:樹狀結構
鏈接類別:系統定義

使用此方向連結來建立一對多關聯性,以追蹤彼此重複的工作、錯誤或其他工作專案。

限制和建議:

  • 工作項目只能有一個重複項目。
  • 請僅使用「重複」或「的重複」連結來連接相同專案中的工作項目。 當您計劃使用 Excel 來修改或更新工作專案數據時,建議您這樣做。

被引用的參考文獻
螢幕擷取畫面顯示 [被引用者] 連結型別的概念圖。 螢幕擷取畫面顯示 [引用] 連結型別的概念圖。

Microsoft.VSTS.TestCase。
引用的共享參數
拓撲類型:相依性
鏈接類別:進程定義

使用此選項可將測試案例連結至共用參數,並支援使用不同資料重複測試。 一般而言,您不會將此連結類型新增至限定範圍連結控制項。

相關
螢幕擷取畫面,顯示相關連結類型的概念圖。

System.LinkTypes.Related
拓撲類型:網路
鏈接類別:系統定義

使用此非方向連結來建立工作專案之間的關聯性。 使用它來連結相同層級的工作專案 (例如,重疊的兩個使用者劇本) 。 [相關] 鏈接類型會建立限制較少的簡單關聯。

  • 關聯相同層級的工作事項。
  • 連結在不同專案中定義並由不同小組管理的工作項目。
  • 在兩層式檢視中尋找和檢視工作專案及其相關工作專案。
  • 建立具有少數限制的簡單關聯性。

繼任者-前任者
螢幕擷取畫面,顯示繼任者相依性的概念圖。 螢幕擷取畫面,顯示前任者相依性的概念圖。

System.LinkTypes.Dependency
拓撲類型:相依性
鏈接類別:系統定義
連結至應該在目前專案之前完成的工作專案時,選擇 [前置任務]。 連結至應該在目前專案之後完成的工作專案時,選擇 [後續專案]。

使用此方向連結來追蹤必須在其他人開始之前完成的任務。 連結的工作會在 Azure Boards 中顯示為前置任務-後續連結。

  • 追蹤其他人開始之前必須完成的任務。
  • 支持一對多關係。
  • 在兩層直接連結查詢檢視中尋找前置任務和後續工作專案。

限制和建議:

  • 當您嘗試建立循環關係時,會出現錯誤。
  • 當您計劃匯出至 Excel 時,僅針對相同專案內的工作項目建立前後關係連結。 您可以跨專案建立前置-後續關聯,但 Excel 匯出/匯入只會包含定義該查詢的專案之項目。

由測試者執行的測試
螢幕擷取畫面,顯示 [依據測試] 連結類型的概念圖。 螢幕擷取畫面,顯示 [測試] 連結類型的概念圖。

Microsoft.VSTS.Common.TestedBy-Forward
Microsoft.VSTS.Common.TestedBy-Reverse
拓撲類型:相依性
鏈接類別:進程定義

將測試案例連結至工作專案,例如 Bug、使用者劇本、需求和 PBI。 使用此來追蹤驗證使用者劇本 (敏捷式) 、PBI (Scrum) 或需求 (CMMI) 的測試案例。 針對內部部署 Azure DevOps,數個 SQL 報表相依於這些連結。 請參閱 檢閱小組活動以支援有用的報告

測試 Case-Shared 步驟
螢幕擷取畫面顯示 [測試案例] 至 [共用步驟] 連結的概念圖。螢幕擷取畫面顯示測試案例連結的共用步驟概念圖。

Microsoft.VSTS.TestCase。
SharedStepReferencedBy
拓撲類型:相依性
鏈接類別:進程定義

使用此選項可將測試案例與共用步驟連結。 在測試案例之間共用步驟,以避免重複相同的步驟序列。

超連結會將工作專案連結至任何 URL。 超連結計數會追蹤工作專案上的超連結數目。

顯示超連結概念圖的螢幕擷取畫面。

連結名稱

支援的工具

成品類型

使用方式


超連結

工作項目追蹤

超連結

使用此選項將工作專案連結至 URL。 工作專案超連結成品連結類型 API 中此連結類型的名稱。

外部連結類型是系統定義的,並將工作專案連結至儲存在 Azure DevOps 內的其他物件。 工作專案的 外部連結計數 等於使用外部連結類型定義的所有連結總和。

顯示外部連結類型概念圖的螢幕擷取畫面。

備註

僅使用外部連結類型來連結至 Azure DevOps 物件。 若要將工作專案連結至 Azure DevOps 外部的物件,請使用 超連結

下表說明當您從工作專案或測試案例新增連結時,您可以選擇的外部連結類型。

下表說明從工作專案或測試案例新增連結時可以選擇的外部連結類型。 您也可以指定其中一個連結類型,以使用 ExternalLinksFilter XML 元素來設定連結控制項的範圍。

連結名稱

支援的工具

成品類型

使用方式


保安警報

進階安全性

進階安全性

用來將工作專案連結至進階安全性警示。

分支

Git

分支

用來將工作專案連結至分支。

管線/組建

建造

建造

用來將工作專案連結至建置。

Changeset (或在 Changeset 中修正)

版本控制

變更集

用來將工作專案連結至變更集。

提交(或在提交中修正)

Git

承諾

用來將一個工作專案連結至提交。

在組建中找到

管線/組建

建造

用來將工作專案連結至建置。

整合在編譯中

建造

組建管線

用來將工作專案連結至建置。

整合於發佈環境中

釋放

發佈流程

用於將發行版本連接至工作項目。 當使用者針對發行定義啟用 報告部署狀態為工作 時,系統會建立此類型。

提取要求

Git

拉取請求識別碼 (PullRequestId)

用來將工作專案連結至提取要求。

結果附件

測試管理

TcmResultAttachment

用來將工作項目連結至與測試結果相關聯的附件。 當您將工作專案與 Test 或 Microsoft Test Manager 中的測試結果產生關聯時,就會顯示這些連結。

原始程式碼檔案

版本控制

最新項目版本

用來將工作專案連結至 Team Foundation 版本控制 (TFVC) 下的檔案。

Storyboard

需求

Storyboard

用於將工作專案連結到網路上的 PowerPoint 檔案或包含分鏡腳本資訊的其他檔案。

標記

Git

標記

用於將工作項目連結到為 Git 提交或存放庫定義的標籤。 如需更多資訊,請參閱 在 Git 命令提示字元中工作

測試結果

測試管理

TcmResult

用來將工作專案連結至測試結果。 當您將工作專案與 Test 或 Microsoft Test Manager 中的測試結果產生關聯時,就會顯示這些連結。

已版本化的項目

版本控制

最新項目版本

用來將工作專案連結至 TFVC 存放庫內定義的檔案或變更集。 原始碼檔成品連結類型 API 中此連結類型的名稱。

維基

維基

維基

用來將工作專案連結至 Wiki 頁面。 支援 TFS 2018.2 和更新版本。

GitHub 連結類型是系統定義的,並將工作專案連結至 GitHub 物件,如下所示。

螢幕擷取畫面,顯示 GitHub 連結類型的概念圖。

這很重要

您只能連結至與 Azure Boards 連結的 GitHub 存放庫的產出物。

下表說明從工作專案新增連結時可以選擇的 GitHub 連結類型。

連結名稱

成品類型

使用方式


GitHub 提交

GitHub 存放庫提交

用於將工作專案連結到 GitHub 提交。

GitHub 問題

GitHub 存放庫問題

用來將工作專案連結至 GitHub 問題。

GitHub 提取要求

GitHub 存放庫提取要求

用來將工作專案連結至 GitHub 提取要求。

遠端工作連結類型支援連結不同組織中定義的工作專案,只要相同的 Microsoft Entra ID 管理這些組織 (請參閱 將您的 組織連線到 Microsoft Entra ID) 。

工作項目的 「遠端鏈結計數」 等於使用遠端工作鏈結類型定義之所有鏈結總和。

名稱

參考名稱

使用方式


消耗 From-Produced
(相依性拓撲)螢幕擷取畫面,顯示 [取用來源] 拓撲的概念圖。螢幕擷取畫面,顯示 [產出給] 拓撲的概念圖。

System.LinkTypes.Remote.Dependency-Forward
System.LinkTypes.Remote.Dependency-Reverse
拓撲類型:相依性
鏈接類別:系統定義

使用此方向連結,在不同組織中定義的工作專案之間建立相依性,只要相同的 Microsoft Entra ID 管理它們即可。 人們通常會使用它來追蹤連結至跨組織邊界需求的變更請求。

遠端相關
螢幕擷取畫面,顯示遠端相關拓撲的概念圖。

System.LinkTypes.Remote.Related
拓撲類型:網路
鏈接類別:系統定義

使用此非方向連結來關聯不同組織中定義的工作專案,只要相同的 Microsoft Entra ID 管理它們即可。

建立自訂連結類型、匯出和匯入連結類型定義,以及刪除、啟用、停用或重新啟用自訂連結類型。 See:

您可以使用支援的命令列工具列出連結類型。

az 董事會工作項目關係列類型

使用 az boards work-item relation list-type 命令或 [工作專案關聯性類型 - 清單 REST API] 列出組織支援的連結類型。 如需詳細資訊,請參閱 開始使用 Azure DevOps CLI

az boards work-item relation list-type [--org]

選擇性參數

  • org: Azure DevOps 組織 URL。 您可以使用 az devops configure -d organization=ORG_URL 來設定預設組織。 如果未設定為預設值或未使用 git config 選取,則為必填項。 範例: --org https://dev.azure.com/MyOrganizationName/.

範例

下列命令會以數據表格式列出為 fabrikam 組織定義的工作專案連結類型。

az boards work-item relation list-type --org fabrikam --output table
Name                  ReferenceName                                                Enabled    Usage
--------------------  -----------------------------------------------------------  ---------  ------------
Produces For          System.LinkTypes.Remote.Dependency-Forward                   True       workItemLink
Consumes From         System.LinkTypes.Remote.Dependency-Reverse                   True       workItemLink
Duplicate             System.LinkTypes.Duplicate-Forward                           True       workItemLink
Duplicate Of          System.LinkTypes.Duplicate-Reverse                           True       workItemLink
Referenced By         Microsoft.VSTS.TestCase.SharedParameterReferencedBy-Forward  True       workItemLink
References            Microsoft.VSTS.TestCase.SharedParameterReferencedBy-Reverse  True       workItemLink
Tested By             Microsoft.VSTS.Common.TestedBy-Forward                       True       workItemLink
Tests                 Microsoft.VSTS.Common.TestedBy-Reverse                       True       workItemLink
Test Case             Microsoft.VSTS.TestCase.SharedStepReferencedBy-Forward       True       workItemLink
Shared Steps          Microsoft.VSTS.TestCase.SharedStepReferencedBy-Reverse       True       workItemLink
Successor             System.LinkTypes.Dependency-Forward                          True       workItemLink
Predecessor           System.LinkTypes.Dependency-Reverse                          True       workItemLink
Child                 System.LinkTypes.Hierarchy-Forward                           True       workItemLink
Parent                System.LinkTypes.Hierarchy-Reverse                           True       workItemLink
Related               System.LinkTypes.Related                                     True       workItemLink
Remote Related        System.LinkTypes.Remote.Related                              True       workItemLink
Attached File         AttachedFile                                                 True       resourceLink
Hyperlink             Hyperlink                                                    True       resourceLink
Artifact Link         ArtifactLink                                                 True       resourceLink

預設 json 格式提供連結類型所定義之屬性的其他資訊。 例如,鏈接類型 產生的消耗來自 的資訊如下所示。

  {
    "attributes": {
      "acyclic": true,
      "directional": true,
      "editable": false,
      "enabled": true,
      "isForward": true,
      "oppositeEndReferenceName": "System.LinkTypes.Remote.Dependency-Reverse",
      "remote": true,
      "singleTarget": true,
      "topology": "dependency",
      "usage": "workItemLink"
    },
    "name": "Produces For",
    "referenceName": "System.LinkTypes.Remote.Dependency-Forward",
    "url": "https://dev.azure.com/mseng/_apis/wit/workItemRelationTypes/System.LinkTypes.Remote.Dependency-Forward"
  },
  {
    "attributes": {
      "acyclic": true,
      "directional": true,
      "editable": false,
      "enabled": true,
      "isForward": false,
      "oppositeEndReferenceName": "System.LinkTypes.Remote.Dependency-Forward",
      "remote": true,
      "singleTarget": true,
      "topology": "dependency",
      "usage": "workItemLink"
    },
    "name": "Consumes From",
    "referenceName": "System.LinkTypes.Remote.Dependency-Reverse",
    "url": "https://dev.azure.com/mseng/_apis/wit/workItemRelationTypes/System.LinkTypes.Remote.Dependency-Reverse"
  },

witadmin listlinktypes

您可以使用命令列工具或witadmin listlinktypes REST API 命令,列出專案集合支援的連結類型。

以下是 fabrikam-sever 預設集合的連結類型清單:

C:\Program Files (x86)\Microsoft Visual Studio\2019\Community\Common7\IDE\CommonExtensions\Microsoft\TeamFoundation\Team Explorer>witadmin listlinktypes /collection:http://fabrikam-server/DefaultCollection

Reference Name: Microsoft.VSTS.TestCase.SharedParameterReferencedBy
Names: Referenced By, References
Topology: Dependency
Is Active: True

Reference Name: Microsoft.VSTS.Common.TestedBy
Names: Tested By, Tests
Topology: Dependency
Is Active: True

Reference Name: Microsoft.VSTS.TestCase.SharedStepReferencedBy
Names: Test Case, Shared Steps
Topology: Dependency
Is Active: True

Reference Name: System.LinkTypes.Duplicate
Names: Duplicate, Duplicate Of
Topology: Tree
Is Active: True

Reference Name: System.LinkTypes.Dependency
Names: Successor, Predecessor
Topology: Dependency
Is Active: True

Reference Name: System.LinkTypes.Hierarchy
Names: Child, Parent
Topology: Tree
Is Active: True

Reference Name: System.LinkTypes.Related
Name: Related
Topology: Network
Is Active: True

下表提供 Azure Boards CLI 或 REST API 所傳回之每個連結類型屬性的描述。

Attribute

說明


名字 name

指定指派給連結類型的易記名稱。 方向連結會以成對定義,因此包含正向和反向名稱。

參考名稱, referenceName

指定指派給連結類型或連結類型組的名稱。

acyclic

指出連結類型是否允許 或 (true) 或限制 (false) 循環關聯性。 例如,樹狀結構類型連結會限制迴圈關聯性。 如需詳細資訊,請參閱 LinkTypes元素參考

directional

指出連結類型是否為方向式(true)還是非方向式(false)。 方向連結類型會與正向和反向元件成對定義。 如需詳細資訊,請參閱 LinkTypes元素參考

editable

指出連結類型是否可編輯 (true) 或否 。false。 您只能使用 witadmin 管理連結類型 命令行工具,為內部部署新增和編輯自定義連結類型。 系統連結類型一律有 editable=false

為作用中, enabled

顯示連結類型是否為使用中(true)或未使用中(false)。 您只能使用 witadmin 管理連結類型 命令行工具,在內部部署中使用自定義連結類型。

isForward

指出連結類型是否在連結類型組內指定正向連結(true)或否(False)。

oppositeEndReferenceName

指定連結類型的參考名稱,這個參考名稱會以連結類型組相反的方向定義連結。

remote

指出連結類型是否支援連結至遠端工作專案(true)或不支援(False)。 的連結類型 remote=false ,要求目標工作專案與原始工作項目位於相同的組織或集合中。

singleTarget

指出連結類型是否允許多個目標 (false) 或限制為單一目標 (true)。

topology

指定拓撲類型: dependencynetworktree。 如需描述,請參閱 鏈接類型拓撲和限制

usage

指定使用類型: resourceLink or workItemLink. The workItemLink 值表示連結兩個工作專案的連結類型。 值 resourceLink 表示連結類型,用來將工作專案連結至資源,例如 URL 或附件。

url

以 json 格式列出連結類型的屬性。