docs(agent-team): document fail-loud dispatch input contract and pr_number hardening#113
Draft
github-actions[bot] wants to merge 1 commit into
Draft
Conversation
…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>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What changed
Mirrors the behavior fixes from #69 into the user-facing
catalog/agent-team/README.md, and repairs a broken link inCONTRIBUTING.md.catalog/agent-team/README.md— Limits and gotchasBefore: The "Input propagation" bullet said agents "must fail loudly if required
workflow_dispatchinputs are missing" with no detail on what that means in practice.After: Two specific bullets replace it:
Input propagation — now documents:
$\{\{ github.event.inputs.issue_number }}) are treated the same as missing values, not as valid input.state:blocked+ error comment whenissue_numberis present;missing_data/report_incompletewhen it is absent.pr_numberhandling (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 sectionReplaced 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