自定义过程模板

Azure DevOps Server 2022 - Azure DevOps Server 2019 |TFS 2018

进程模板定义创建项目时可用的对象和进程。 通过自定义进程模板,可以自定义其中一个对象。 可以创建的常见自定义类型包括:

  • 将新字段添加到现有工作项类型 (WIT)
  • 为字段修改值的选取列表
  • 更改现有 WIT 的工作流(状态、原因、转换、操作)
  • 编辑工作项窗体的布局
  • 添加或移除工作项类型
  • 更改与敏捷工具关联的进程配置或默认值

注意

如果要查找 用于软件开发的项目模板 ,请参阅 创建 Visual Studio 模板。 本主题介绍用于创建在 Azure DevOps Services 和 TFS 上定义的项目的过程模板。

默认过程模板定义默认配置以及团队可用于规划和跟踪工作、进行协作和共享信息的以下工件。

例如,敏捷过程模板定义下图中显示的项目集。

敏捷过程模板工项目

敏捷流程模板项目

这些项目中的许多项目取决于用于跟踪工作的 WIT。 例如,WIT 定义中定义的数据字段(如功能、Bug、用户情景或任务)也用于定义工作项查询和报表。 除了这些工件,你还可以定义最初的项目区域和里程碑、安全配置和其他支持版本控制和测试管理的默认设置。

创建项目后,可以更改配置并自定义项目。 但是,通过在创建项目之前自定义流程模板,从中创建的所有生成的项目都将与一组标准团队流程匹配。 你希望自定义过程模板的主要原因可能包括:

  • 你计划创建多个项目,并且希望尽量减少在创建的每个项目中稍后必须实现的重复任务。

  • 通过在工具集(你的软件开发团队将会使用)中提供模板和结构,你希望确保所有团队都遵守一定的标准。

  • 你需要更新自定义过程模板,以便在 TFS 升级后支持配置功能向导的使用

如果只处理单个项目,则可以考虑稍后只创建项目并自定义一个或多个对象。

如何使用过程模板?

过程模板的主要用途是创建项目。 对于托管 XML 进程模型,它还用于更新项目。 项目提供在相互依赖的模板文件中定义的对象、项目和配置集。 使用项目来组织源代码、跟踪工作和信息、生成软件和支持测试活动。

托管 XML 流程模型

本地 XML 流程模型

  • 创建项目

我应从何处着手?

在开始自定义流程模板之前,需要熟悉可以配置和自定义的内容,然后相应地规划更改。

  • 如果你不熟悉处理模板,请先 查看默认进程模板

  • 若要熟悉进程模板的文件结构, 请查看每个文件的说明下载进程模板

    创建项目后,可以修改项目的进程。 使用项目时,定义的进程模板的初始设置可能不再满足你的需求。

  • 如果最感兴趣的是自定义用于跟踪工作的对象(包括测试计划、测试套件和测试用例),请查看 自定义工作跟踪体验。 通过修改项目的 XML 定义文件进行的自定义项与在进程模板文件中进行的自定义类型相同。

    如果要 添加或修改工作项的类型,可以在不更改整个流程模板的情况下实现此目的。 可以使用现有项目进行和测试更改。 对于本地 XML 进程模型,可以使用 witadmin exportwitdimportwitd 命令行工具下载和上传工作项类型的 XML 定义文件。

  • 如果需要更新自定义进程模板以支持在 TFS 升级后使用“配置功能”向导,请参阅 升级后配置功能

    将 TFS 升级到更高版本会上载默认 TFS 过程模板的最新版本。 若要使用可用的更新模板并访问之前进行的自定义,可能需要添加随新模板提供的自定义项。

  • 如果你正在考虑进行广泛的自定义, 请查看所做的更改如何影响项目的维护和升级

你可以自定义的过程模板文件和功能区域

进程模板由 9 个插件组成。每个插件定义一组将运行的任务,以及启动“新建团队项目”向导时出现的屏幕。 这些任务将设置权限、创建文件夹、上载文件、激活网站或设置其他可配置的变量。 插件还指定了一项任务对其他任务成功完成的依赖关系。

TFS_PT_Plugins处理模板插件

重要

从 Web 门户创建项目时,会忽略多个进程模板文件。 具体而言,不支持创建报表管理器网站和 SharePoint 项目门户的文件。

如果希望为本地 TFS 上的项目创建这些功能,请从 Visual Studio 或团队资源管理器创建项目。 有关详细信息,请参阅 进程模板和插件文件、客户端对项目创建的支持

生成、门户和报告插件需要安装并配置以下资源。

插件 Team Foundation Build SharePoint 产品 SQL Server Analysis Services SQL Server Reporting Services
构建 必需
门户 必需 必需 推荐 只需要支持基本的仪表板
报告 必需 必需

要自定义过程模板,你需要自定义与功能区域相关的一个或多个文件。 自定义任意一个对象非常简单时,需要确保在自定义时不会中断任何相互依赖性。 ProcessTemplate.xml插件文件定义要在模板中包含哪些插件。 此文件包含要运行以创建项目的所有任务组。 每个任务组引用一个下属 XML 插件文件,其中定义了该插件的特定任务。

Teams、组、权限、 & 区域和迭代路径

工作项跟踪

  • WIT 定义
  • 类别
  • 进程配置
  • 链接类型
  • 工作项工作项查询
  • 版本控制、生成、实验室和测试管理

    报表和项目门户

    因为过程模板涉及团队过程的许多组件,你可能希望进行计划、合作并跟踪你将要做出的更改。 尤其是在对任何一个区域进行更改前,你可能希望与项目领导、测试领导、开发领导以及发布经理一起进行核查。

    插件依赖项

    许多对象依赖于其他对象在过程模板的定义。

    例如,为 Agile 过程模板定义的工作项查询用的就是 Classification.xml 文件中定义的迭代节点。 如果你更改了迭代节点定义,则你必须修改它们所依赖的工作项查询。 你可以通过在 .wiq 文件中搜索以下宏来查找这些查询:

    • Iteration 1 = @@Iteration%201@@
    • Iteration 2 = @@Iteration%202@@
    • Iteration 3 = @@Iteration%203@@

    有关所需插件和插件依赖项的概述,请参阅 定义任务组和任务的依赖项

    插件和命名限制

    向过程模板添加对象时,你需要确保对它们的标注正确以避免 XML 验证错误。

    • 对大多数 Team Foundation 对象的名称或标签施加限制。 有关应用于进程模板、安全组、区域和迭代节点、工作项类型和工作项字段的命名限制的概述,请参阅 命名限制

    • 自定义的大多数进程模板组件将仅影响使用进程模板创建的项目。 此规则的例外是全局列表、链接类型和工作项字段。 这些对象是为项目集合定义的。

    • 每个工作项字段都有一个相关联的唯一标识该字段的字段引用名称。 引用名称在指定后不能更改。

      此外,工作项字段也可以有一个指定的报告名称。 报告名称必须与为项目集合定义的所有工作项类型匹配。 如果不匹配,在上传该过程模板时会出现验证错误,或在数据仓库数据库中出现冲突。

      工作项字段名称、链接类型名称和全局列表的范围限定为项目集合。 如果自定义这些对象中的任何一个,则更改将反映在集合中定义的所有项目以及包含该工作项字段的工作项类型中。

    • 过程模板最大为 2 GB。 在自定义过程模板时,请确保所做的更改没有将其大小增加到超过该值。

    自定义过程模板的步骤

    自定义过程模板是一个迭代的过程。 你需要在运行 Team Foundation Server 的服务器上定义的项目集合,你可以在其中测试进程模板,以确保正确自定义它。

    要自定义过程模板,你首先要下载一个现存的过程模板,修改或添加文件,上传过程模板文件,然后确认更改。

    进程模板自定义工作流

    步骤 任务
    第 1 步 下载进程模板。 在自定义过程模板之前,你必须将其下载到本地计算机上。

    若要最大程度地减少必须做出的修改,请选择最符合团队流程的 模板 。 通常,根据工作项和工作流类型选择过程模板。
    第 2 步 修改或添加文件。 通过修改、删除或添加为过程模板定义的文件来自定义过程模板。 通过修改 XML 内容来自定义插件或定义文件。 每个插件文件和类型定义文件必须符合其 XML 架构定义。

    第一次自定义过程模板时,做少许更改。 如果在没有了解所做更改会如何影响模板的情况下做了更改,你可能会遇到多个难以调试的错误。

    请确保你的过程模板的名称统一。 如果你下载了一个过程模板,做了更改并要上传,则你必须更改它的名称,否则它会从项目集合覆盖现有过程模板。
    第 3 步 上传进程模板。 自定义模板后,将其上传到要在其中创建项目的项目集合。

    理想情况下,应使用其他项目不使用的项目集合。 通过在测试台项目集合中工作,你可以避免引入可能与现有团队过程(仍然有待开发)冲突的变化。 此外,还需要项目集合支持想要访问的相同资源,例如项目门户和报告网站。

    请确保你的过程模板的名称统一。 如果从项目集合下载了进程模板,进行了更改,并且现在正在上传模板,则必须更改其名称或删除项目集合中的现有进程模板。

    上传过程执行验证检查以确保 XML 有效。 如果在上传该过程模板的过程中,收到错误,则可能是由于所做的更改造成的。 查看更改,并将发现的任何 XML 语法错误更改过来。
    第 4 步 创建项目。 若要测试新的进程模板,必须创建一个项目。 可以通过从团队资源管理器访问“新建团队项目向导”来创建项目。

    如果发生任何错误,请查看用于创建项目的日志。 日志包含其试图运行的任务的列表并显示失败的任务。 你可以将失败的任务映射回 XML 以确定错误的原因。

    可以使用 TFSDeleteProject 命令行工具清理不必要的项目。
    步骤 5 验证对处理模板所做的更改。 在将进程模板置于生产模式并将其用作多个项目的基础之前,应验证它是否定义良好。 系统地执行该任务,从而确定每个对象和项目按预期运行。

    如果添加了报表,请确保它显示在团队资源管理器中。 如果添加了字段,请确保未引入任何架构冲突。

    有时,第三方会创建可用的进程模板。 使用第三方提供的进程模板时,可能需要执行额外的工作,如自定义 工作跟踪体验、维护和升级影响 (TFS) 中所述。

    所需的权限

    若要下载或上传进程模板,你必须是 项目集合管理员 组的成员,或者必须将 “管理”进程模板 权限设置为 “允许”。 请参阅 更改项目集合级权限

    支持自定义流程模板的工具

    可以使用以下工具之一自定义进程模板:

    进程编辑器工具提供了一个用户界面,可用于自定义以下区域:

    • 工作项跟踪
      • 创建和编辑 WIT 定义,包括添加字段、更改工作流以及修改旧样式 (TFS 2017) 工作项表单
      • 添加或编辑分类,为工作项类型分组
      • 为 Agile 计划工具编辑过程配置
      • 创建和编辑工作项查询,并将查询归入查询文件夹
      • 创建和编辑链接类型
    • 项目分类和层次结构
      • 创建和编辑产品区域的路径
      • 创建和编辑里程碑版本或迭代路径
      • 修改 Microsoft Project 的映射文件
    • 安全组:创建和编辑 TFS 组及其权限
    • 版本控制
      • 编辑签出设置
      • 创建和编辑签入笔记
      • 创建和编辑 TFS 组以及它们的权限
    • 门户和报表
      • 查看将要上传的文件及它们的文件结构
      • 添加将要上传的文件。

    无法通过流程模板文件自定义 Office Excel 报表和仪表板。 根据你在“新建团队项目”向导中所做的选择,为项目创建这些项目。 有关详细信息,请参阅 自定义 TFS 项目门户