Skip to content

docs: clarify rate-limit-safe dispatcher setup#344

Merged
vincentkoc merged 1 commit into
mainfrom
fix/ci-setup-example
Jun 21, 2026
Merged

docs: clarify rate-limit-safe dispatcher setup#344
vincentkoc merged 1 commit into
mainfrom
fix/ci-setup-example

Conversation

@vincentkoc

Copy link
Copy Markdown
Member

Summary

  • document the required ClawSweeper App/private-key setup for target repositories
  • make the target dispatcher example copy-pasteable and explicitly single-fanout
  • pre-filter issue comments before minting a target installation token
  • document live verification for ordinary comments, maintainer commands, and missing secrets

Verification

  • git diff --check
  • autoreview --mode branch --base origin/main — clean, no accepted/actionable findings
  • verified the documented filter matches the canonical ClawSweeper command grammar and skips ordinary comments

@clawsweeper

clawsweeper Bot commented Jun 21, 2026

Copy link
Copy Markdown
Contributor

Codex review: needs maintainer review before merge. Reviewed June 21, 2026, 12:13 AM ET / 04:13 UTC.

Summary
The PR updates docs/target-dispatcher.md to document GitHub App setup, a single target dispatcher workflow, early comment-command filtering, and live verification checks for dispatcher behavior.

Reproducibility: not applicable. this is a docs PR rather than a bug report. The review checked the sample against current command-router source and tests.

Review metrics: 1 noteworthy metric.

  • Changed surface: 1 docs file modified, 0 runtime or workflow files. The merge impact is limited to copy-paste dispatcher guidance rather than code executed by this repository.

Merge readiness
Overall: 🐚 platinum hermit
Proof: 🌊 off-meta tidepool
Patch quality: 🐚 platinum hermit
Result: ready for maintainer review.

Overall follows the weaker of proof and patch quality, so missing proof can cap an otherwise strong patch.

Rank-up moves:

  • none.

Next step before merge

  • [P2] No repair lane is needed because the diff is docs-only, aligned with current command-router code/tests, and has no actionable finding.

Security
Cleared: Cleared: the PR changes documentation only and does not modify executable workflows, dependencies, secrets handling, or package sources in this repository.

Review details

Best possible solution:

Land the narrow docs clarification once normal CI/review is satisfied, preserving parity with the existing webhook command filter and pinned GitHub App token workflow.

Do we have a high-confidence way to reproduce the issue?

Not applicable; this is a docs PR rather than a bug report. The review checked the sample against current command-router source and tests.

Is this the best way to solve the issue?

Yes; documenting the existing webhook pre-filter in the copy-paste target dispatcher is the narrowest maintainable path because the runtime command grammar already exists and is tested.

AGENTS.md: found and applied where relevant.

Codex review notes: model internal, reasoning high; reviewed against 1566ad6a0a5b.

Label changes

Label changes:

  • add P3: This is low-risk documentation and operator setup clarification for the dispatcher workflow.
  • add rating: 🐚 platinum hermit: Overall readiness is 🐚 platinum hermit; proof is 🌊 off-meta tidepool and patch quality is 🐚 platinum hermit.
  • add status: 👀 ready for maintainer look: ClawSweeper has no concrete contributor-facing blocker left for this PR. Not applicable: Real behavior proof is not required because this PR only changes files under docs/.

Label justifications:

  • P3: This is low-risk documentation and operator setup clarification for the dispatcher workflow.
  • rating: 🐚 platinum hermit: Overall readiness is 🐚 platinum hermit; proof is 🌊 off-meta tidepool and patch quality is 🐚 platinum hermit.
  • status: 👀 ready for maintainer look: ClawSweeper has no concrete contributor-facing blocker left for this PR. Not applicable: Real behavior proof is not required because this PR only changes files under docs/.
Evidence reviewed

What I checked:

Likely related people:

  • vincentkoc: Authored the merged rate-limit dispatcher docs follow-up at fix(ci): reduce ClawSweeper GitHub API pressure #343 and recent exact-queue/comment-webhook work used as the source of truth for this PR. (role: recent area contributor; confidence: high; commits: 1566ad6a0a5b, ac8f2c5e61c2; files: docs/target-dispatcher.md, src/repair/comment-webhook.ts)
  • Peter Steinberger: Established much of the current target dispatcher documentation in the release commit and made nearby exact-queue docs updates. (role: original and recent docs contributor; confidence: medium; commits: dc824915bb6c, 30163dfd667b; files: docs/target-dispatcher.md)
What the crustacean ranks mean
  • 🦀 challenger crab: rare, exceptional readiness with strong proof, clean implementation, and convincing validation.
  • 🦞 diamond lobster: very strong readiness with only minor maintainer review expected.
  • 🐚 platinum hermit: good normal PR, likely mergeable with ordinary maintainer review.
  • 🦐 gold shrimp: useful signal, but proof or patch confidence is still limited.
  • 🦪 silver shellfish: thin signal; proof, validation, or implementation needs work.
  • 🧂 unranked krab: not merge-ready because proof is missing/unusable or there are serious correctness or safety concerns.
  • 🌊 off-meta tidepool: rating does not apply to this item.

Shiny media proof means a screenshot, video, or linked artifact directly shows the changed behavior. Runtime, network, CSP, and security claims still need visible diagnostics.

How this review workflow works
  • ClawSweeper keeps one durable marker-backed review comment per issue or PR.
  • Re-runs edit this comment so the latest verdict, findings, and automation markers stay together instead of adding duplicate bot comments.
  • A fresh review can be triggered by eligible @clawsweeper re-review comments, exact-item GitHub events, scheduled/background review runs, or manual workflow dispatch.
  • PR/issue authors and users with repository write access can comment @clawsweeper re-review or @clawsweeper re-run on an open PR or issue to request a fresh review only.
  • Maintainers can also comment @clawsweeper review to request a fresh review only.
  • Fresh-review commands do not start repair, autofix, rebase, CI repair, or automerge.
  • Maintainer-only repair and merge flows require explicit commands such as @clawsweeper autofix, @clawsweeper automerge, @clawsweeper fix ci, or @clawsweeper address review.
  • Maintainers can comment @clawsweeper explain to ask for more context, or @clawsweeper stop to stop active automation.

@clawsweeper clawsweeper Bot added rating: 🐚 platinum hermit Good normal PR readiness with ordinary maintainer review expected. status: 👀 ready for maintainer look ClawSweeper has no concrete contributor-facing blocker left for this PR. P3 Low-risk cleanup, docs, polish, ergonomics, or speculative feature. labels Jun 21, 2026
@vincentkoc
vincentkoc merged commit f94c65a into main Jun 21, 2026
9 checks passed
@vincentkoc
vincentkoc deleted the fix/ci-setup-example branch June 21, 2026 04:23
ostehost pushed a commit to ostehost/clawsweeper that referenced this pull request Jun 22, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

P3 Low-risk cleanup, docs, polish, ergonomics, or speculative feature. rating: 🐚 platinum hermit Good normal PR readiness with ordinary maintainer review expected. status: 👀 ready for maintainer look ClawSweeper has no concrete contributor-facing blocker left for this PR.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant