tapd:comment

提交 tapd 关联项（story、task 或 bug）评论

在代码提交时，您可以在提交信息或PR 描述中添加 TAPD 源码关键字， 云原生构建系统将自动识别并关联 Commits、PR 和 TAPD 工作项。

在代码推送、PR 和 Tag 相关流水线中，可以通过该任务更新 TAPD 关联项的信息。

前提条件

• 需在根组织中启用 TAPD 功能。
• 流水线触发者需绑定 TAPD 账号。

TAPD 关联项筛选规则

流水线将根据以下规则筛选关联的 TAPD 工作项：

1. 当传入 fromFile 或 fromText 参数时：

从传入的文本文件或文本中解析出 commit IDs，并查询其关联的 TAPD 工作项。

fromFile 优先级高于 fromText。

2. 当未传入 fromFile 或 fromText 参数时：

• PR 相关事件：

  查询该 PR 的 commits 以及 PR 描述中关联的 TAPD 工作项。

• commit.add 事件：

  查询新增 commits 关联的 TAPD 工作项。

• 非新建分支的 push 事件：

  从本次推送的所有 commits 的提交日志中获取关联的 TAPD 工作项。

• 其他情况：

  查询最新 commit 所关联的 TAPD 工作项。

TAPD 关联项类型

TAPD 工作项 源码关键字 中的类型即为工作项类型，如：story、task、bug。

需要注意的是，TAPD 任务的源码关键字可能为 story 或 task，请注意区分。

• 适用事件
• 参数
• 配置样例

适用事件

所有事件

参数

以下列表先概览 tapd:comment 的全部参数。

• comment：评论内容
• when：仅对指定状态的工作项添加评论
• type：仅对指定类型（story/task/bug）的工作项添加评论
• fromText：从文本解析 commit id（最多 50 个），查询关联工作项
• fromFile：从文件解析 commit id，查询关联工作项

各参数详细说明如下。

comment

• type: String
• required: true

评论内容。

when

• type: String | Array<String>
• required: false

对符合指定状态的工作项添加评论，为空时不做过滤。

type

• Enum<String>: story | task | bug
• required: false

对符合指定类型的工作项添加评论，为空时不做过滤。

fromText

• type: String
• required: false

从文本中解析出 commit id（最多 50 个），查询其关联的工作项。

fromFile

• type: String
• required: false

从文本文件中解析出 commit id，查询其关联的工作项。

配置样例

1. 评论所有 TAPD 关联项：

.cnb.yml

main:
  push:
    - stages:
        - name: add tapd comment
          type: tapd:comment
          options:
            comment: 开始开发

2. 对符合条件的 TAPD 关联项添加评论：

.cnb.yml

main:
  pull_request.merged:
    - stages:
        - name: add tapd comment
          type: tapd:comment
          options:
            comment: 已合并
            when:
              - 进行中
            type: story

3. 从 fromText 中解析 commit id，查询 TAPD 关联项并评论

.cnb.yml

$:
  tag_push:
    - stages:
        - name: 生成 changelog
          image: cnbcool/changelog
          settings:
            dryRun: true
            linkReferences: false
          exports:
            latestChangeLog: RELEASE_NOTES
        - name: tapd
          type: tapd:comment
          options:
            comment: 已发布
            type: story
            fromText: $RELEASE_NOTES