Skip to content

docs(agent-team): document fail-loud dispatch input contract and pr_number hardening#113

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

docs(agent-team): document fail-loud dispatch input contract and pr_number hardening#113
github-actions[bot] wants to merge 1 commit into
mainfrom
docs/agent-team-dispatch-input-hardening-04c89e11797d98f9

Conversation

@github-actions
Copy link
Copy Markdown
Contributor

What changed

Mirrors the behavior fixes from #69 into the user-facing catalog/agent-team/README.md, and repairs a broken link in CONTRIBUTING.md.

catalog/agent-team/README.md — Limits and gotchas

Before: The "Input propagation" bullet said agents "must fail loudly if required workflow_dispatch inputs are missing" with no detail on what that means in practice.

After: Two specific bullets replace it:

  • Input propagation — now documents:

    • That unresolved template literals (e.g. $\{\{ github.event.inputs.issue_number }}) are treated the same as missing values, not as valid input.
    • The two failure modes: state:blocked + error comment when issue_number is present; missing_data / report_incomplete when it is absent.
    • Explicit prohibition against label-search or recent-activity inference as a fallback.
  • pr_number handling (implementer only) — new bullet documenting that a blank value or the unresolved literal $\{\{ github.event.inputs.pr_number }} both mean "create a new branch", not "update an existing PR".

CONTRIBUTING.md — Publishing section

Replaced a broken link to README.md#publishing (that section was removed in v0.2 and never replaced) with the actual publishing steps inline.

Testing

All 28 tier-2 invariant checks pass (bash tests/test-invariants.sh).

Checklist

  • Invariants green
  • No new files created
  • No code changed — documentation only

Generated by Update Docs ·

To install this agentic workflow, run

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

…umber hardening

Mirrors the fixes from #69 (fail loud on missing dispatch inputs, harden
optional implementer pr_number) in the user-facing README:

- Expand the "Input propagation" gotcha to describe the two failure modes
  (state:blocked comment when issue_number is present; missing_data /
  report_incomplete when it is absent) and call out that unresolved
  template literals are treated the same as missing values.
- Add a "pr_number handling" gotcha documenting that blank *or* unresolved
  literal → new branch, not an update to an existing PR.

Also fix a broken link in CONTRIBUTING.md: the "Publishing" section it
pointed to was removed in v0.2 and never replaced.

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