Skip to content

docs: document agent-team dispatch input hardening and add troubleshooting guide#136

Draft
github-actions[bot] wants to merge 1 commit into
mainfrom
docs/agent-team-dispatch-input-hardening-7cd0d5a0e15838f6
Draft

docs: document agent-team dispatch input hardening and add troubleshooting guide#136
github-actions[bot] wants to merge 1 commit into
mainfrom
docs/agent-team-dispatch-input-hardening-7cd0d5a0e15838f6

Conversation

@github-actions
Copy link
Copy Markdown
Contributor

What changed and why

Follow-up documentation for #69 (fix(agent-team): fail loud on missing dispatch inputs + fix(agent-team): harden optional implementer pr_number). The code behavior was updated in that commit but the reference docs didn't reflect the new contracts — this PR closes that gap.

catalog/agent-team/README.md

  • Input propagation gotcha — upgraded from a vague "must fail loudly" statement to the exact observed behavior: the stalled agent adds state:blocked and posts the specific error comment (🛑 agent-team: workflow_dispatch inputs were not propagated. Re-dispatch with valid inputs.), or emits missing_data when issue_number itself is absent. Explicitly calls out that no inference from labels/activity ever happens.
  • New pr_number gotcha — documents the implementer's optional input semantics: blank/absent = open a new draft PR (first attempt); real PR number = push updates to existing branch (kickback). This was hardened in [codex] fix agent-team manual workflow_dispatch inputs #69 but undocumented.
  • Step 4 re-dispatch examples — replaces vague gh workflow run mention with concrete commands for all four re-dispatch scenarios (planner, implementer first-attempt, implementer kickback, reviewer), so a human debugging a stuck pipeline can copy-paste rather than guess.
  • New Troubleshooting section — three scenarios covering the most likely failure modes after [codex] fix agent-team manual workflow_dispatch inputs #69: inputs-not-propagated recovery, duplicate PR from missing pr_number, and silent spec-agent on label churn.

CONTRIBUTING.md

  • Fix inaccurate testing claim — the section opened with "There is no automated test harness for skills" which was false: tests/run-tests.sh runs Claude Code headlessly to assert skill behavior. Corrected to describe the actual test suite and how to run it.
  • Tier-3 guidance for catalog contributors — added a note that catalog/agent-team/*.md changes should be validated with the tier-3 e2e tests, not just the fast tier-1/2 suite.

Testing

Documentation-only change — no code modified. Verified diff reads correctly and cross-references resolve.

Generated by Update Docs ·

To install this agentic workflow, run

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

- Update catalog/agent-team/README.md:
  - Input propagation gotcha: describe exact error behavior (state:blocked
    + specific comment text) and missing_data fallback when issue_number
    is absent — mirrors the fail-loud contract added in #69
  - New `pr_number` gotcha: clarify blank = first-attempt (new PR) vs
    real number = kickback (update existing PR)
  - Step 4 re-dispatch: replace vague prose with concrete gh workflow run
    examples for each role, covering both first-attempt and kickback paths
  - New Troubleshooting section: three scenarios — inputs not propagated,
    duplicate PR from missing pr_number, silent spec-agent on label add

- Update CONTRIBUTING.md:
  - Fix inaccurate "no automated test harness" claim: the repo ships a
    tiered test suite (tests/run-tests.sh) that runs Claude Code headlessly
  - Add test-suite commands and guidance to run tier-3 e2e tests for
    catalog/agent-team changes

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 23, 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