Skip to content

chore: refresh starter icons and prepare initial release notes - #12

Merged
steipete merged 4 commits into
mainfrom
triage/cookbook-release-notes-20260905
Sep 7, 2026
Merged

steipete merged 4 commits into
mainfrom
triage/cookbook-release-notes-20260905

Conversation

@steipete

@steipete steipete commented Sep 5, 2026 •

Copy link
Copy Markdown
Contributor

Prepare the initial cookbook source-release notes from behavior already on main, and refresh Lucide from 1.40.0 to 1.41.0 across the root and both browser starters. The lockfile also picks up tinyexec 1.3.1; both releases exceed the workspace's 48-hour minimum age.

The notes cover six recipes, four copyable starters, CLI cancellation, and structured CLI output redaction. They no longer claim Agent Workbench result redaction: #10 is closed unmerged, and its implementation is absent from this candidate. The complete ordered Unreleased section lives only in this PR, with contributor credit for #7 and #8.

Validation: the full pnpm check gate passes all 20 tests, documentation checks for six recipes, all four starter builds, and both compiled CLI smokes. A frozen install succeeds and pnpm audit reports zero vulnerabilities. In real Chrome, the production Workbench completes a synthetic run with three events and expected assistant text; Run Board creates a completed run and filters it under Done. The compiled interactive CLI completes a synthetic prompt with redacted JSON and exits cleanly on idle Ctrl+C. These runtime checks use the documented workspace SDK shim, not a live Gateway/provider.

Vitest 4 and pnpm 10 remain pinned pending an explicit Node runtime-support decision. A first exploratory Vitest 5 run hit three subprocess timeouts on the shared host; the final dependency set passed using a fresh short private macOS temp directory without changing test timeouts.

Recommend an initial v0.1.0 GitHub source release after final-main validation and release authorization. All packages remain private; no npm, Homebrew, or notarization step is needed. This PR does not tag or publish a release.

Rendered release notes at this commit: https://github.com/openclaw/cookbook/blob/32c1a60541e57271338b3e8f83091501ea4b48ce/CHANGELOG.md

Exact-head Cookbook and examples CI passed; both CodeQL analysis jobs and the aggregate check passed. Local and branch autoreview through P2 are clean. The linked rendered changelog was visually verified in real Chrome.

@clawsweeper

clawsweeper Bot commented Sep 5, 2026 •

Copy link
Copy Markdown

🦞👀
ClawSweeper picked this up.

Pull request received. I will update this pull request when review starts.

ClawSweeper review complete

ClawSweeper finished reviewing this revision. The review result is being finalized.

View the workflow run.

@steipete

steipete commented Sep 5, 2026

Copy link
Copy Markdown
Contributor Author

Prepared release-note proof for fc0d5a4c0d32c8c5afe827755f51ace70ec571b6: pnpm exec oxfmt --check CHANGELOG.md and pnpm docs:check passed (all six recipe documents registered). Independent branch autoreview through P2 is clean.

No prior tag or GitHub release exists. The complete Unreleased section covers the initial recipes/starters plus the prepared fixes and maintenance in #7, #8, #10, and #11. Land this last and retain its complete section when reconciling their changelog insertions. Recommendation: initial v0.1.0 GitHub source release only, after combined-main validation. No tag, release, version bump, or package publication has been performed.

@steipete

steipete commented Sep 5, 2026

Copy link
Copy Markdown
Contributor Author

Final preparation: all five PR heads have successful Cookbook and examples CI runs:

I also assembled a local combined candidate, resolving the CLI source/README overlap between #7 and #8 and retaining this complete changelog. pnpm check passed all 23 tests and all starter builds/smokes. The compiled CLI passed real PTY cancellation and Ctrl+C shutdown checks; production Workbench completed a run in real Chrome and masked the synthetic session key. The active cancellation cases use the documented SDK shim with a synthetic held-open stream; no live Gateway/network abort is claimed. Independent autoreview through P2 is clean for every branch and the combined candidate.

Recommended landing order is #7, #8, #10, #11, then #12. Reconcile the overlapping files using the verified candidate, retain each output redaction call in the new cancellation lifecycle, and rerun exact-head CI after any reconciliation. No merge, close, tag, or release has been performed.

@clawsweeper

clawsweeper Bot commented Sep 5, 2026 •

Copy link
Copy Markdown

Codex review: needs maintainer review before merge. Reviewed September 7, 2026, 6:33 AM ET / 10:33 UTC.

ClawSweeper review

What this changes

Consolidates the initial cookbook release notes and updates Lucide icons across both browser starters, with a matching lockfile refresh.

Merge readiness

✅ Ready for maintainer review

The release-note consolidation and icon update remain useful and are not on main. The previous inaccurate redaction claim is corrected, and the supplied runtime observations address the earlier proof request; no blocking defect was found.

Priority: P3
Reviewed head: 32c1a60541e57271338b3e8f83091501ea4b48ce

Review scores

Measure Result What it means
Overall readiness 🐚 platinum hermit (4/6) A bounded maintenance patch with corrected release claims, relevant runtime observations, and successful reported validation.
Proof confidence 🐚 platinum hermit (4/6) Sufficient (live_output): The captured exact-head Chrome observations exercise both production icon consumers using the documented workspace shim, with successful rendering and run interactions; the contributor also records visual inspection of the corrected linked changelog. Independent preview retrieval failed, but that reviewer limitation does not invalidate the supplied observations.
Patch quality 🐚 platinum hermit (4/6) No actionable review findings were identified.

Verification

Check Result Evidence
Real behavior Verified Sufficient (live_output): The captured exact-head Chrome observations exercise both production icon consumers using the documented workspace shim, with successful rendering and run interactions; the contributor also records visual inspection of the corrected linked changelog. Independent preview retrieval failed, but that reviewer limitation does not invalidate the supplied observations.
Evidence reviewed 8 items Remaining work against current main: The complete comparison against fetched main contains five files: CHANGELOG.md, three package manifests, and pnpm-lock.yaml, totaling 26 insertions and 18 deletions. Lucide changes from 1.40.0 to 1.41.0 and tinyexec from 1.3.0 to 1.3.1. CLI sources and tests match main.
Parentage and inherited implementation: Raw commit inspection confirms the original head has fetched main f02aed0 and the earlier release-note head as parents. The supplied GitHub metadata verifies #8 and #11 are merged; their CLI and dependency changes are already present on main. The stale test-merge record was not used to infer removals.
Previous finding resolved: The highlight now limits redaction to CLI JSON, and the detailed bullet names Quickstart and Coding Agent CLI. Workbench still renders raw result JSON, consistent with the supplied metadata showing #10 closed unmerged.
Findings None None.
Security None None.

How this fits together

The cookbook provides copyable SDK recipes and terminal/browser starter apps. Its browser starters turn prompts and SDK run results into controls, event displays, and run-status cards; the changelog summarizes those capabilities.

flowchart LR
  A[User prompts] --> B[Browser starters]
  C[Lucide icons] --> B
  B --> D[Workspace SDK shim]
  D --> E[Events and run results]
  E --> B
  F[Implemented cookbook features] --> G[Release notes]
Loading

Before merge

None.

Agent review details

Security

None.

Review metrics

Metric Value Why it matters
Remaining scope 5 files; +26 / -18 lines against current main The broader supplied delta includes already-merged CLI and dependency work.

Technical review

Best possible solution:

Keep the accurate consolidated notes and consistent icon update, with any source release authorized separately after final-main validation.

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

Not applicable: this is maintenance work; current source confirms that the earlier inaccurate Workbench redaction claim has been removed.

Is this the best way to solve the issue?

Yes: the remaining diff uses the existing dependency manifests and changelog without adding runtime behavior or changing supported configuration.

AGENTS.md: not found in the target repository.

Codex review notes: model internal, reasoning medium; reviewed against f02aed0af828.

Labels

Label changes:

  • add proof: sufficient: Contributor real behavior proof is sufficient. The captured exact-head Chrome observations exercise both production icon consumers using the documented workspace shim, with successful rendering and run interactions; the contributor also records visual inspection of the corrected linked changelog. Independent preview retrieval failed, but that reviewer limitation does not invalidate the supplied observations.
  • add rating: 🐚 platinum hermit: Overall readiness is 🐚 platinum hermit; proof is 🐚 platinum hermit and patch quality is 🐚 platinum hermit.
  • add status: 👀 ready for maintainer look: ClawSweeper has no concrete contributor-facing blocker left for this PR. Sufficient (live_output): The captured exact-head Chrome observations exercise both production icon consumers using the documented workspace shim, with successful rendering and run interactions; the contributor also records visual inspection of the corrected linked changelog. Independent preview retrieval failed, but that reviewer limitation does not invalidate the supplied observations.
  • remove rating: 🦪 silver shellfish: Current PR rating is rating: 🐚 platinum hermit, so this older rating label is no longer current.
  • remove status: 📣 needs proof: Current PR status label is status: 👀 ready for maintainer look.

Label justifications:

  • P3: The remaining work is release-note preparation and a bounded icon dependency refresh.
  • rating: 🐚 platinum hermit: Overall readiness is 🐚 platinum hermit; proof is 🐚 platinum hermit and patch quality is 🐚 platinum hermit.
  • status: 👀 ready for maintainer look: ClawSweeper has no concrete contributor-facing blocker left for this PR. Sufficient (live_output): The captured exact-head Chrome observations exercise both production icon consumers using the documented workspace shim, with successful rendering and run interactions; the contributor also records visual inspection of the corrected linked changelog. Independent preview retrieval failed, but that reviewer limitation does not invalidate the supplied observations.
  • proof: sufficient: Contributor real behavior proof is sufficient. The captured exact-head Chrome observations exercise both production icon consumers using the documented workspace shim, with successful rendering and run interactions; the contributor also records visual inspection of the corrected linked changelog. Independent preview retrieval failed, but that reviewer limitation does not invalidate the supplied observations.

Evidence

What I checked:

  • Remaining work against current main: The complete comparison against fetched main contains five files: CHANGELOG.md, three package manifests, and pnpm-lock.yaml, totaling 26 insertions and 18 deletions. Lucide changes from 1.40.0 to 1.41.0 and tinyexec from 1.3.0 to 1.3.1. CLI sources and tests match main. (package.json:33, 32c1a60541e5)
  • Parentage and inherited implementation: Raw commit inspection confirms the original head has fetched main f02aed0 and the earlier release-note head as parents. The supplied GitHub metadata verifies fix(cli): redact sessionKey from starter CLI JSON output #8 and chore(deps): refresh cookbook maintenance dependencies #11 are merged; their CLI and dependency changes are already present on main. The stale test-merge record was not used to infer removals. (32c1a60541e5)
  • Previous finding resolved: The highlight now limits redaction to CLI JSON, and the detailed bullet names Quickstart and Coding Agent CLI. Workbench still renders raw result JSON, consistent with the supplied metadata showing fix(workbench): redact sensitive fields in run result JSON #10 closed unmerged. (CHANGELOG.md:5, 32c1a60541e5)
  • Behavior proof at reviewed head: The captured comment chore: refresh starter icons and prepare initial release notes #12 (comment) reports production Chrome runs at the reviewed SHA: both starters rendered icons, Workbench produced three events and assistant text, and Run Board counts changed from 3/1 to 4/2 with two completed cards under Done. It also records compiled CLI redaction and successful idle Ctrl+C shutdown, plus visual inspection of the rendered changelog. These are explicitly local workspace-shim observations, not live Gateway claims. (sdk/agent-workbench/src/App.tsx:2, 32c1a60541e5)
  • Documented local runtime and validation: README.md and the browser starter READMEs document the private workspace SDK shim as the local runnable setup. The supplied exact-head checks report success, and the contributor records a frozen install, zero audit vulnerabilities, all 20 tests, four starter builds, and two compiled CLI smokes. No tests or target code were executed during this review. (README.md:21, 32c1a60541e5)
  • Dependency and release boundary: The remaining diff preserves package privacy, Node requirements, lifecycle scripts, pnpm 10.34.5, the 2,880-minute minimum release age, and Vite/esbuild overrides. Main still has only the short Unreleased section; local tag enumeration returned no tags. This PR prepares notes without tagging or publishing. (pnpm-workspace.yaml:10, 32c1a60541e5)

Likely related people:

  • steipete: Suggested for follow-up; no historical authorship or introduction is verified. (role: unverified routing candidate; confidence: low)
  • Vincent Koc: Suggested for follow-up; no historical authorship or introduction is verified. (role: unverified routing candidate; confidence: low)

Rating scale

Score Internal tier Crab rank Meaning
6/6 S 🦀 challenger crab Exceptional readiness
5/6 A 🦞 diamond lobster Very strong readiness
4/6 B 🐚 platinum hermit Good normal PR; ordinary maintainer review
3/6 C 🦐 gold shrimp Useful, but confidence is limited
2/6 D 🦪 silver shellfish Proof or implementation needs work
1/6 F 🧂 unranked krab Not merge-ready
N/A NA 🌊 off-meta tidepool Rating does not apply

Overall follows the weaker of proof and patch quality.
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.

Workflow

  • 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.

History

Review history (3 earlier review cycles)
  • reviewed 2026-09-05T20:15:15.840Z sha fc0d5a4 :: needs real behavior proof before merge. :: none
  • reviewed 2026-09-05T20:31:54.226Z sha 31fe879 :: needs real behavior proof before merge. :: [P2] Limit the redaction release note to landed implementations
  • reviewed 2026-09-06T01:18:43.761Z sha 31fe879 :: needs real behavior proof before merge. :: [P2] Limit the redaction release note to landed implementations

Consolidate the complete user-visible history for the initial cookbook source release, including cancellation, structured-output redaction, and dependency maintenance.

No version, tag, release, or package publication is created.
steipete added a commit to SebTardif/cookbook that referenced this pull request Sep 5, 2026
Apply the established redaction policy to standalone result, status, and cancellation JSON while preserving the cancellation lifecycle already on main. Keep each starter independently copyable.

Release notes are consolidated in PR openclaw#12.

Co-authored-by: Sebastien Tardif <sebtardif@ncf.ca>
steipete added a commit to SebTardif/cookbook that referenced this pull request Sep 5, 2026
Mask sensitive fields at the Result display boundary without changing the stored result, session settings, SDK requests, or assistant stream.

Release notes are consolidated in PR openclaw#12.

Co-authored-by: Sebastien Tardif <sebtardif@ncf.ca>
steipete added a commit that referenced this pull request Sep 5, 2026
Update six maintenance dependencies consistently across the workspace manifests and lockfile. Preserve pnpm 10.34.5, the two-day release-age policy, and Vite/esbuild overrides.

Release notes are consolidated in PR #12.
@steipete
steipete force-pushed the triage/cookbook-release-notes-20260905 branch from fc0d5a4 to 31fe879 Compare September 5, 2026 20:24
steipete added a commit that referenced this pull request Sep 5, 2026
Update six maintenance dependencies consistently across the workspace manifests and lockfile. Preserve pnpm 10.34.5, the two-day release-age policy, and Vite/esbuild overrides.

Release notes are consolidated in PR #12.
@steipete

steipete commented Sep 5, 2026

Copy link
Copy Markdown
Contributor Author

Restacked independently onto main 6deea84fc44138676bdf0d4b99dae98ec33d43ff at 31fe8790ff47dc5c2bfb85245a347232057a27b8.

This PR owns the single complete Unreleased section. The four PRs touch disjoint files and reconstruct the previously proven combined source tree exactly (56576a9cc5b03069b71700b776279ba19763d030).

The full cookbook gate passed (17 tests, formatting, types, lint, docs, all four starter builds, and both compiled CLI smokes). Branch autoreview through P2 is clean. Exact-head CI: https://github.com/openclaw/cookbook/actions/runs/33990017335

Local runs were serialized using short private macOS temp directories after concurrent subprocess timeouts and a too-long tsx socket path. No test timeouts or product code were weakened. No merge or release performed.

SebTardif and others added 2 commits September 5, 2026 13:37
Apply the established cookbook redaction policy to standalone starter result, status, and cancellation JSON while preserving independently copyable examples and verbatim assistant streams.

Validated both compiled starters and the full cookbook gate.

Co-authored-by: Sebastien Tardif <sebtardif@ncf.ca>
Update six maintenance dependencies consistently across workspace manifests and the lockfile. Preserve pnpm 10.34.5, the two-day release-age policy, and Vite/esbuild overrides.

Validated frozen installation, the full cookbook gate, compiled CLI runs, and both production browser examples.
@clawsweeper clawsweeper Bot added P3 Low-risk cleanup, docs, polish, ergonomics, or speculative feature. rating: 🦪 silver shellfish Thin PR readiness signal; proof, validation, or implementation needs work. status: 📣 needs proof The PR needs real behavior proof before ClawSweeper can clear the contributor ask. labels Sep 6, 2026
Limit the initial release notes to landed CLI redaction, preserve contributor credit, and update Lucide across both browser starters with a consistent lockfile.
@steipete steipete changed the title docs: prepare initial cookbook release notes chore: refresh starter icons and prepare initial release notes Sep 7, 2026
@steipete

steipete commented Sep 7, 2026

Copy link
Copy Markdown
Contributor Author

Phase-two proof at 32c1a60541e57271338b3e8f83091501ea4b48ce:

  • pnpm check passed all 20 tests, formatting, types, lint, all six recipe docs, all four starter builds, and both compiled CLI smoke runs. pnpm install --frozen-lockfile passed; pnpm audit reported zero vulnerabilities.
  • In real Chrome, the production Agent Workbench completed a synthetic prompt with three events and hello from OpenClaw. Its Result still displayed the synthetic session key, confirming that fix(workbench): redact sensitive fields in run result JSON #10 is absent and must not be advertised as landed. The production Run Board's New run action changed total/completed counts from 3/1 to 4/2; Done filtering retained the two completed cards. Both apps rendered their icons correctly.
  • The actual compiled Coding Agent CLI ran in a PTY, accepted a synthetic session and prompt, completed with sessionKey: "[REDACTED]", then exited with status 0 on idle Ctrl+C. These checks exercise the documented local SDK shim; no live Gateway/provider or network-abort proof is claimed.
  • Opened and visually inspected the rendered changelog at this exact commit in Chrome. All ten bullets and the Highlights lead-in render correctly; the redaction claim is limited to command-line JSON.
  • Independent local and committed-branch autoreview through P2 are scoped-clean. No test timeouts were changed; the final suite passed with a fresh, short private macOS temp directory after an exploratory Vitest 5 run hit subprocess timeouts. Vitest 4 and pnpm 10 are retained pending the runtime-support decision.

The Lucide 1.41.0 and tinyexec 1.3.1 releases both satisfy the 48-hour minimum dependency age. This PR is now independent of closed #10 and is the only open PR. No GitHub PR was merged or closed, and no tag or release was created.

Exact-head CI is green: Cookbook and examples / Check completed successfully. Both CodeQL analysis jobs and the CodeQL aggregate check are successful. The current ClawSweeper dispatch succeeded; its earlier duplicate dispatch was superseded/cancelled. The optional [code]smith check is skipped.

@clawsweeper clawsweeper Bot added proof: sufficient Contributor real behavior proof is sufficient. 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. and removed rating: 🦪 silver shellfish Thin PR readiness signal; proof, validation, or implementation needs work. status: 📣 needs proof The PR needs real behavior proof before ClawSweeper can clear the contributor ask. labels Sep 7, 2026
@steipete
steipete merged commit d4c2718 into main Sep 7, 2026
10 of 11 checks passed
@vincentkoc
vincentkoc deleted the triage/cookbook-release-notes-20260905 branch September 25, 2026 11:11
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. proof: sufficient Contributor real behavior proof is sufficient. 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.

2 participants