Skip to content

Commit 369d0f0

Browse files
docs: fix update-work-item target field documented as optional default (#514)
The target field for update-work-item is required (compile-time validation rejects configs that omit it) but was documented with a comment saying '"*" (default)' in safe-outputs.md, incorrectly implying it has a default value. Changes: - docs/safe-outputs.md: change comment from '"*" (default)' to 'Required —' and add a Note block matching the pattern used by comment-on-work-item - prompts/create-ado-agentic-workflow.md: move target to the top of the update-work-item example block and add a 'Required' comment, consistent with how comment-on-work-item shows its target field Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
1 parent fe90c20 commit 369d0f0

2 files changed

Lines changed: 4 additions & 2 deletions

File tree

docs/safe-outputs.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -108,14 +108,16 @@ safe-outputs:
108108
title-prefix: "[bot] " # only update work items whose title starts with this prefix
109109
tag-prefix: "agent-" # only update work items that have at least one tag starting with this prefix
110110
max: 3 # maximum number of update-work-item outputs allowed per run (default: 1)
111-
target: "*" # "*" (default) allows any work item ID, or set to a specific work item ID number
111+
target: "*" # Required — "*" allows any work item ID, or set to a specific work item ID number
112112
area-path: true # enable area path updates (default: false)
113113
iteration-path: true # enable iteration path updates (default: false)
114114
assignee: true # enable assignee updates (default: false)
115115
tags: true # enable tag updates (default: false)
116116
allowed-tags: [] # Optional — restrict which tags the agent can set (empty = any; supports * wildcards like "agent-*")
117117
```
118118
119+
**Note:** The `target` field is required. If omitted, compilation fails with an error. This ensures operators are intentional about which work items agents can update.
120+
119121
**Security note:** Every field that can be modified requires explicit opt-in (`true`) in the front matter configuration. If the `max` limit is exceeded, additional entries are skipped rather than aborting the entire batch.
120122

121123
### create-pull-request

prompts/create-ado-agentic-workflow.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -320,10 +320,10 @@ safe-outputs:
320320
target: "TeamProject\\AreaPath" # Required — scopes which work items can be commented on
321321
max: 3
322322
update-work-item:
323+
target: "*" # Required — "*" allows any work item, or set to a specific ID number
323324
status: true # Each updatable field requires explicit opt-in
324325
title: true
325326
max: 5
326-
target: "*"
327327
add-pr-comment:
328328
max: 10
329329
queue-build:

0 commit comments

Comments
 (0)