链接类型的参考指南

Azure DevOps Services |Azure DevOps Server |Azure DevOps Server 2022 |Azure DevOps Server 2020

使用不同的链接类型来管理工作项和其他项目之间的关系,例如生成、提交和拉取请求。 本文介绍以下链接类型。

特定字段维护前四个链接类型的链接计数,例如 相关链接计数超链接计数外部链接计数远程链接计数

特定字段维护前三个链接类型的链接计数,例如 相关链接计数超链接计数外部链接计数

链接类型具有拓扑限制。 根据计划创建的查询和报表,使用下表中的指南来选择链接类型。 若要了解有关拓扑的详细信息,请参阅 链接类型拓扑和限制

工作链接类型是系统定义的、进程定义的或用户定义的(自定义)。 下表中列出的链接是系统定义的。

每个工作链接类型定义在工作项之间构造链接时使用的标签、拓扑和限制。 例如,父子链接类型定义了两个标签:父节点和子节点。 链接类型使用树拓扑,并阻止工作项之间的循环引用。

显示工作项链接类型的概念图的屏幕截图。

工作项 的相关链接计数 等于使用工作链接类型定义的所有链接的总和。

下表描述了可以使用 WorkItemLinksFilter XML 元素指定的工作项链接类型来限定链接控件的范围。

名称

引用名称

用法


Affects-Affected by( 仅 CMMI) 显示影响链接类型的概念图的屏幕截图。显示受影响链接类型的概念图的屏幕截图。

Microsoft.VSTS.Common.Affects-Forward
Microsoft.VSTS.Common.Affects-Reverse
拓扑类型:依存关系
链接类别:进程定义

使用此方向链接可以在工作项之间创建链接,而无需创建闭合循环。 人们通常使用它来跟踪与需求相关的更改请求。

限制和建议:

  • 使用“Affects”功能将更改请求链接至一个唯一的需求。 使用“受影响”将需求链接到任意数量的子更改请求。
  • 只能在同一项目中使用“影响-影响者”链接来链接工作项。 当你计划使用 Excel 修改或更新工作项数据时,我们建议这样做。

父子关系
显示子链接类型的概念图的屏幕截图。
显示父链接类型的概念图的屏幕截图。

System.LinkTypes.Hierarchy-Forward
System.LinkTypes.Hierarchy-Reverse
拓扑类型:树
链接类别:系统定义

使用此定向链接在单个父项与一个或多个子项之间创建一对多关系。 使用它来组织层次结构中的工作项。 可以使用映射函数在积压工作项之间创建层次结构,或者通过冲刺积压任务板在积压工作项和任务之间创建层次结构。

典型用途包括:

  • 维护任务摘要关系。 父子链接表示摘要任务及其从属任务。
  • 将任务链接到 PBI、用户情景或要求。 支持积压工作概述、情景概述和要求概述报告。

限制和建议:

  • 使用 Excel 同时批量编辑工作项和父子链接。 请参阅使用 Excel 批量添加或修改工作项
  • 一个工作项只能有一个父级。 一个父工作项可以有多个子级。
  • 仅使用父子链接来链接同一项目中的工作项。 当你计划使用 Excel 修改或更新工作项数据时,我们建议这样做。

Duplicate-Duplicate of屏幕截图,其中显示了“重复链接类型”的概念图。显示“重复链接类型”概念图的屏幕截图。

System.LinkTypes.Duplicate-Forward
System.LinkTypes.Duplicate-Reverse
拓扑类型:树
链接类别:系统定义

使用此定向链接可创建一对多关系来跟踪相互复制的任务、bug 或其他工作项。

限制和建议:

  • 一个工作项只能有一个重复项。
  • 只能在同一项目中使用“重复项或副本”链接来链接工作项。 当你计划使用 Excel 修改或更新工作项数据时,我们建议这样做。

引用方-引用
显示“被引用”链接类型概念图的屏幕截图。 显示“引用”链接类型概念图的屏幕截图。

Microsoft.VSTS.TestCase。
SharedParameterReferencedBy
拓扑类型:依存关系
链接类别:进程定义

使用此方法可将测试用例链接到共享参数,并支持使用不同的数据重复测试。 通常,不会将此链接类型添加到作用域链接控制项。

相关
显示相关链接类型的概念图的屏幕截图。

System.LinkTypes.Related
拓扑类型:网络
链接类别:系统定义

使用此非定向链接可在工作项之间创建关系。 使用它可以链接同一级别的工作项(例如,两个重叠的用户故事)。 相关链接类型创建具有少量限制的简单关系。

  • 关联同一级别的工作项。
  • 在不同项目中定义并由不同团队管理的工作项之间建立链接。
  • 在两层视图中查找和查看工作项及其相关工作项。
  • 创建具有少量限制的简单关系。

后继者-前任者
显示用于表示后续依赖关系的概念图的屏幕截图。 显示用于表示前置依赖关系的概念图的屏幕截图。

System.LinkTypes.Dependency
拓扑类型:依存关系
链接类别:系统定义
在链接到应在当前项之前完成的工作项时,选择前置项。 链接到应在当前项之后完成的工作项时选择 “后续任务 ”。

使用此指向链接跟踪在其他任务开始之前必须完成的任务。 链接的任务在 Azure Boards 中显示为前置-后续关系链接。

  • 跟踪必须完成的任务,以便其他任务可以开始。
  • 支持一对多关系。
  • 在双层直接链接查询视图中查找前序和后续工作项。

限制和建议:

  • 尝试创建循环关系时会出现错误。
  • 计划导出到 Excel 时,仅为同一项目中的工作项创建前置-后续链接。 可以在不同项目之间创建前后置任务链接,但 Excel 导出/导入将仅包含定义该查询的项目的条目。

测试方-测试
显示“被测试的链接类型”概念图的屏幕截图。 展示“测试链接类型”概念图的屏幕截图。

Microsoft.VSTS.Common.TestedBy-Forward
Microsoft.VSTS.Common.TestedBy-Reverse
拓扑类型:依存关系
链接类别:进程定义

将测试用例链接到工作项,例如 bug、用户情景、要求和 PBIs。 使用此函数可跟踪验证用户情景(敏捷)、PBIs(Scrum)或要求(CMMI)的测试用例。 对于本地 Azure DevOps,多个 SQL 报告依赖于这些链接。 请参阅 “审查团队活动”以支持有用的报告

测试用例-共享步骤
显示“测试用例到共享步骤”链接的概念图的屏幕截图。 显示“共享步骤到测试用例”链接的概念图的屏幕截图。

Microsoft.VSTS.TestCase。
SharedStepReferencedBy
拓扑类型:依存关系
链接类别:进程定义

使用此函数可将测试用例与共享步骤链接。 在测试用例之间共享步骤 ,以避免重复相同的步骤序列。

超链接将工作项链接到任何 URL。 超链接计数跟踪工作项上的超链接数。

显示超链接的概念图的屏幕截图。

链接名称

支持的工具

项目类型

用法


超链接

工作项跟踪

超链接

使用此工具将工作项链接到 URL。 工作项超链接项目链接类型 API 中此链接类型的名称。

外部链接类型是系统定义的,并将工作项链接到存储在 Azure DevOps 中的其他对象。 工作项的外部 链接计数 等于使用外部链接类型定义的所有链接的总和。

显示外部链接类型的概念图的屏幕截图。

注释

仅使用外部链接类型链接到 Azure DevOps 对象。 若要将工作项链接到 Azure DevOps 外部的对象,请使用 超链接

下表描述了从工作项或测试用例添加链接时可以选择的外部链接类型。

下表描述了从工作项或测试用例添加链接时可以选择的外部链接类型。 还可以指定以下链接类型之一,以使用 ExternalLinksFilter XML 元素限定链接控件的范围。

链接名称

支持的工具

项目类型

用法


安全警报

高级安全

高级安全

用于将工作项链接到高级安全警报。

分支

Git

分支

用于将工作项链接到分支。

管道/构建

构建

构建

用于将一个工作项链接到构建。

变更集(或已在变更集中修复)

版本控制

变更集

用于将工作项链接到变更集。

提交(或已在提交中修复)

Git

提交

用于将工作项链接到提交。

在生成中找到

管道/构建

构建

用于将一个工作项链接到构建。

在生成中集成

构建

构建流水线

用于将一个工作项链接到构建。

在发布环境中集成

发布

发布管道

用于将发布链接到工作项。 当用户为发布定义启用将部署状态报告给工作时,系统会创建此类型。

拉取请求

Git

PullRequestId

用于将工作项链接到拉取请求。

结果附件

测试管理

TcmResultAttachment

用于将工作项链接到与测试结果关联的附件。 将工作项与 测试 或Microsoft测试管理器中的测试结果相关联时,将显示这些链接。

源代码文件

版本控制

最新项目版本

用于将工作项链接到 Team Foundation 版本控制(TFVC)下的文件。

Storyboard

要求

Storyboard

用于将工作项链接到 PowerPoint 文件或其他包含网络上情节提要信息的文件。

标记

Git

标记

用于将工作项链接到为 git 提交或存储库定义的标签。 有关详细信息,请参阅 从 Git 命令提示符进行操作

测试结果

测试管理

TcmResult

用于将工作项链接到测试结果。 将工作项与 测试 或Microsoft测试管理器中的测试结果相关联时,将显示这些链接。

有版本的项目

版本控制

最新项目版本

用于将工作项链接到在 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”。

工作项的 远程链接计数 等于使用远程工作链接类型定义的所有链接的总和。

名称

引用名称

用法


使用来源-生产目的
(依赖项拓扑) 显示“从拓扑使用”的概念图的屏幕截图。显示“已生成用于拓扑”的概念图的屏幕截图。

System.LinkTypes.Remote.Dependency-Forward
System.LinkTypes.Remote.Dependency-Reverse
拓扑类型:依存关系
链接类别:系统定义

使用此方向链接可在不同组织中定义的工作项之间创建依赖关系,只要相同的Microsoft Entra ID 管理它们。 人们通常使用此来跟踪跨组织边界与要求相关的更改请求。

远程相关
显示远程相关拓扑的概念图的屏幕截图。

系统.链接类型.远程.相关
拓扑类型:网络
链接类别:系统定义

使用此非定向链接来关联在不同组织中定义的工作项,只要相同的Microsoft Entra ID 管理它们。

创建自定义链接类型、导出和导入链接类型定义,以及删除、激活、停用或重新激活自定义链接类型。 请参阅:

可以使用支持的命令行工具列出链接类型。

az boards 工作项关系 列表类型

使用 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 返回的每个链接类型属性的说明。

属性

说明


名称,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 格式列出链接类型的属性。