Skip to content

docs(agent-team): add manual dispatch examples and missing-inputs recovery path#128

Draft
github-actions[bot] wants to merge 1 commit into
mainfrom
docs/agent-team-manual-dispatch-recovery-df640f5f7434ea14
Draft

docs(agent-team): add manual dispatch examples and missing-inputs recovery path#128
github-actions[bot] wants to merge 1 commit into
mainfrom
docs/agent-team-manual-dispatch-recovery-df640f5f7434ea14

Conversation

@github-actions
Copy link
Copy Markdown
Contributor

What and why

PR #69 hardened all three dispatch-triggered agents (planner, implementer, reviewer) to fail loudly when workflow_dispatch inputs are missing or unresolved, instead of silently falling back to label inference. The agents now post 🛑 agent-team: workflow_dispatch inputs were not propagated and add state:blocked.

The README was updated as part of that fix to note the contract, but left a user-facing gap: there were no example commands showing how to re-dispatch a stage, and no recovery path documented for the specific missing-inputs failure mode. A user seeing the blocked error would know what went wrong but not how to fix it.

Changes

catalog/agent-team/README.md

  • Step 4 (human override): replaced the terse $\{\{ github.event.inputs.* }} callout with concrete gh workflow run commands for every role, including the optional pr_number kickback variant:

    gh workflow run planner-agent     -f issue_number=<N> -f iteration=<K>
    gh workflow run implementer-agent -f issue_number=<N> -f iteration=<K>
    gh workflow run implementer-agent -f issue_number=<N> -f iteration=<K> -f pr_number=<P>
    gh workflow run reviewer-agent    -f pr_number=<P>    -f issue_number=<N> -f iteration=<K>
  • Step 5 (retrying a blocked task): split into two sub-cases:

    • Normal block — existing behavior: clear state:blocked, re-add agent-team
    • Missing-inputs block — new: re-dispatch the affected stage via gh workflow run with explicit inputs. Explicitly warns not to re-add agent-team (which would restart from spec, losing the existing spec/plan/PR).
  • Limits > Input propagation: expanded to include the exact error message users will see and a pointer back to the recovery commands.

tests/test-invariants.sh

  • Updated the README invariant from checking for $\{\{ github.event.inputs.* }} (removed) to checking for gh workflow run planner-agent (the new concrete content). Same intent — confirms the manual-dispatch contract is documented.

Test plan

  • bash tests/test-invariants.sh — all 26 invariants pass locally
  • CI tier-1 + tier-2 (runs automatically on this PR)

Generated by Update Docs ·

To install this agentic workflow, run

gh aw add githubnext/agentics/workflows/update-docs.md@96b9d4c39aa22359c0b38265927eadb31dcf4e2a

…overy path

After #69 hardened all three dispatch-triggered agents to fail loudly
on missing workflow_dispatch inputs, the README's "Kicking off a task"
section only noted the contract existed — it didn't tell users what to
actually type when a stage gets blocked by a propagation failure.

Changes:
- Step 4: replace the terse ${{ github.event.inputs.* }} callout with
  concrete `gh workflow run` commands showing every field name for each
  role (planner, implementer, reviewer), including the optional
  pr_number kickback variant.
- Step 5: split "Retrying a blocked task" into two sub-cases:
  normal block (re-add label) vs. missing-inputs block (re-dispatch
  with explicit inputs, NOT re-add label — that restarts from spec).
- Limits > Input propagation: add the error message users will see
  (🛑 workflow_dispatch inputs were not propagated) and a one-line
  pointer back to the recovery commands in step 4.
- test-invariants.sh: update the README invariant to check for
  "gh workflow run planner-agent" (the new concrete content) instead
  of the removed ${{ github.event.inputs.* }} reference.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@github-actions github-actions Bot added automation documentation Improvements or additions to documentation labels May 19, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

automation documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

0 participants