tapd:status-update
About 473 wordsAbout 2 min
tapd:status-update
Update the status of TAPD-associated items (story, task, or bug)
When to use it: use it when TAPD item status should follow code progress, such as marking an associated item as done after a PR is merged.
This task updates the TAPD work items associated with the pipeline. For how items are identified, the fromFile / fromText precedence, and prerequisites, see the TAPD work item filtering rules for tapd:comment.
Applicable Events
Parameters
The list below gives an overview of all tapd:status-update parameters.
- status: Target status
- when: Update only items in a given status
- type: Update only items of a given type (story/task/bug)
- fromText: Parse commit ids from text to find linked items
- fromFile: Parse commit ids from a file to find linked items
Detailed descriptions for each parameter are provided below.
status
- Type:
String - Required:
true
Target status.
when
- Type:
String|Array<String> - Required:
false
Update work items with the specified status. No filtering is applied if left empty.
type
Enum<String>: story | task | bug- Required:
false
Update work items of the specified type. No filtering is applied if left empty.
fromText
- Type:
String - Required:
false
Parse commit IDs (up to 50) from the provided text and query their associated work items.
fromFile
- Type:
String - Required:
false
Parse commit IDs from the provided text file and query their associated work items.
Configuration Examples
- Update the status of all TAPD-associated items:
main:
push:
- stages:
- name: update tapd status
type: tapd:status-update
options:
status: developing- Update the status of TAPD-associated items that meet specific conditions:
main:
pull_request.merged:
- stages:
- name: update tapd status
type: tapd:status-update
options:
status: Completed
when:
- developing
type: story- Parse commit IDs from
fromText, query TAPD-associated items, and update their status:
$:
tag_push:
- stages:
- name: Generate changelog
image: cnbcool/changelog
settings:
dryRun: true
linkReferences: false
exports:
latestChangeLog: RELEASE_NOTES
- name: tapd
type: tapd:status-update
options:
status: published
type: story
fromText: $RELEASE_NOTES