Skip to content

Commit 358326a

Browse files
tadeleshtadeleshmarkcowl
authored
Fix doc-update workflow to create single PR with lib label (#4255)
- Change label of doc updater PR/issue - Enforce max: 1 on create-pull-request to prevent multiple PRs - Add explicit prompt instruction to batch all edits into one PR Co-authored-by: tadelesh <chenjieshi@microsoft.com> Co-authored-by: markcowl <1054056+markcowl@users.noreply.github.com>
1 parent 2e94dc2 commit 358326a

2 files changed

Lines changed: 5 additions & 3 deletions

File tree

.github/workflows/doc-update-scheduler.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,8 @@ name: Documentation Update Scheduler
77
# (an agentic workflow compiled to doc-update.md.lock.yml).
88
#
99
# To add a new package:
10-
# 1. Create a YAML config in eng/scripts/doc-updater/configs/
11-
# 2. Create prompt files in eng/scripts/doc-updater/prompts/<name>/
10+
# 1. Create a YAML config in eng/scripts/doc-updater/configs/<name>.yaml
11+
# 2. Create a prompt file at eng/scripts/doc-updater/prompts/<name>.md
1212
# 3. The scheduler will auto-discover and dispatch it.
1313

1414
on:

.github/workflows/doc-update.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,8 @@ network:
8787
safe-outputs:
8888
create-pull-request:
8989
title-prefix: "[Automated][${{ github.event.inputs.config }}] "
90-
labels: [documentation, automated]
90+
labels: [docs, "lib:${{ github.event.inputs.config }}"]
91+
max: 1
9192

9293
post-steps:
9394
- name: Validate file scope
@@ -168,6 +169,7 @@ been pre-computed and is available in `/tmp/gh-aw/agent/context.json`.
168169
- **Complete every step in the domain-specific prompt.** Do not stop after finishing one step. After each step, explicitly state which step you just completed and which step you are starting next. Continue until all steps are done.
169170
- **Do not defer work.** Fix every issue you find in this run. Do not leave "remaining gaps" or "future work" in the knowledge base or PR description — the knowledge base is for lessons learned, not a to-do list.
170171
- **Update the knowledge base** at `knowledgePath` as you work (see Knowledge Base Rules below).
172+
- **Create exactly one pull request at the very end.** Complete ALL file edits across ALL steps first, then create a single pull request that contains every change. Do NOT call `create_pull_request` after each step or file — batch everything into one PR.
171173

172174
## Knowledge Base Rules
173175

0 commit comments

Comments
 (0)