用于软件开发的工单、修订版和版本

在本教程中,我们将介绍如何在 Shotgun 中使用工单、修订版和版本来管理软件开发过程。我们将首先介绍一些创新功能,然后介绍如何围绕当前工作流来自定义自己的 Shotgun。

快速设置

启用工单、修订版和版本

首先,您将需要启用实体工单、修订版和版本。也可以选择启用工具实体。如果您希望按工具或应用程序(例如“镜头提交工具”、“头发工作流”等)来组织不同的项目,那么启用工具会非常有用。对于像您一样使用 Scrum 的用户,您可以将自定义实体用于 Sprint。启用其中一个自定义实体,并将其重命名为“Sprint”。

创建项目以跟踪开发工作

您将需要一个项目来包含所有版本、工单和修订版(以及工具、Sprint 等)。可为每个软件项目创建一个项目,也可以为所有开发项目创建单个项目。我们的几个客户有一个“研发”项目,他们使用该项目来跟踪所有开发。

在项目中创建“工单”(Tickets)页面

现在,让我们创建一个“工单”(Tickets)页面,然后将该页面置于“Shotgun”项目中。如果您决定将工作组织到多个项目中,请为每个项目创建一个“工单”(Tickets)页面。

“工单”(Tickets)菜单

使用工单

工单附带一些基本的默认字段:

  • 标题(Title)
  • 优先级(Priority)
  • 分配给(Assigned To)
  • 标记(Tags)
  • 说明(Description)
  • 项目(Project)

让我们看一下填好的工单页面,以便更好地了解如何使用这里的每一个字段:

工单页面

“相关工单”(Related Tickets)、“版本”(Releases)和“修订”(Revisions)字段为“多实体”,这意味着一个工单可以有多个相关工单,可以与多个版本相关,并且可以包括许多修订版。

单击一个工单并查看其详细信息页面,以便在错误工单上下文中看到所有这些字段:

工单详细信息页面

工单详细信息页面有一个可配置的标题和侧面板,并包含一个线程回复部分,您可以从中打开或关闭事件。我们在上面看到了第一个事件,其中 Nephi Sanchez 创建了工单。

自动链接相关工单

工单的一个特点是:如果您在说明或回复中的任何位置为工单引用键入前缀“#”,Shotgun 将会在“相关工单”(Related Tickets)字段中为该工单自动创建一个条目。文本将自身转换为所引用工单的链接,显示其当前状态,并在所引用工单的“相关工单”(Related Tickets)字段中相应地创建一个指向当前工单的链接:

相关工单

将修订版自动链接到工单

与自动链接相关工单类似,在修订版前面添加小写“r”会将该文本自动转换为一个链接,并在“修订”(Revisions)字段中自动创建一个条目:

修订版

使用修订版

在工单 #8131 中,我们看到开发人员检入的两个代码修订版。让我们单击其中一个来了解一下详情:

修订版详细信息

修订版详细信息页面在可配置标题中显示了一些元数据。我们还有一个与 Trac 集成的选项卡,而 Trac 是与 Subversion 搭配使用的 Web 界面。为了完成此集成,我们使用 Shotgun 的 API 编写一个简单脚本,使检入过程触发在 Shotgun 中创建修订版并更新所有相关元数据。

名为“Trac Details”的选项卡将修订版编号(“代码”)接收为参数,以便我们可以从修订版详细信息页面中访问 Trac。以下是选项卡的具体配置:

选项卡配置

修订版附带以下默认字段:

  • 说明(Description)
  • Id
  • 项目(Project)
  • 相关修订(Related Revisions)
  • 修订名称(Revision Name)
  • 标记(Tags)
  • 工单(Tickets)
  • URL

“相关修订”(Related Revisions)和“工单”(Tickets)均为多实体字段:一个修订版可以有多个相关修订版和多个工单。

使用版本

版本附带以下默认字段:

  • 说明(Description)
  • Id
  • 项目(Project)
  • 版本名称(Release Name)
  • 状态(Status)
  • 标记(Tags)
  • 工单(Tickets)

“工单”(Tickets)字段为多实体,因此版本可以有多个工单,如我们在此“版本”(Releases)页面中所见:

版本

让我们单击版本详细信息页面。

版本详细信息页面

我们再次看到顶部部分已被配置为显示一些关键元数据,接下来是一大堆选项卡。所有这些选项卡(“修订”(Revisions)选项卡除外)均为“工单”(Ticket)选项卡。每个选项卡都使用工单的标记、状态和其他字段以各种方式来过滤工单,进而显示我们所希望看到的内容。不过,“修订”(Revisions)选项卡被配置为显示版本中的所有修订版,方法是通过“修订”(Revision)的“工单”(Ticket)字段进行查询以显示其中的哪些工单已链接到当前版本:

过滤(Filter)

从本质上来讲,此查询会检查每个修订版的工单,如果其中任何工单被链接到当前版本,它会将这些工单显示在选项卡中。

接下来,我们看看在 Shotgun 中添加的一些用于改进流程的自定义设置。当然,您将希望按照自己的方式为流程自定义一些设置。希望以下内容可以为您提供一些好的想法。

使用 Sprint

在 Shotgun,我们想要将工单组织到 Sprint 中,因此我们启用其中一个自定义实体并将其命名为“Sprint”:

新的 Sprint 实体附带以下字段:

  • 说明(Description)
  • Id
  • 项目(Project)
  • 版本(Release)
  • Sprint
  • 状态(Status)
  • 标记(Tags)
  • 缩略图(Thumbnail)

接下来,我们将添加一些自定义字段:

  • Expected Date
  • Velocity
  • Velocity Notes

每个版本都可能具有多个 Sprint。

现在,在“工单”(Tickets)上添加一个实体字段,名为“Sprint”。

这样,我们便可将每个工单分配给一个 Sprint,因而能够按 Sprint 对工单进行分组、过滤和排序。

接下来,我们准备跟踪软件开发!

关注

0 评论

登录写评论。