Skip to content

docs(openclaw): sync documented SDK pin#882

Open
agent-p1p wants to merge 1 commit into
masterfrom
pip/mdk-881
Open

docs(openclaw): sync documented SDK pin#882
agent-p1p wants to merge 1 commit into
masterfrom
pip/mdk-881

Conversation

@agent-p1p

@agent-p1p agent-p1p commented Jul 15, 2026

Copy link
Copy Markdown
Contributor

Fixes #881

Summary

  • Update both README SDK/prerequisite references from openclaw@2026.6.8 to the package pin, openclaw@2026.6.11.
  • Add a Vitest regression guard that derives the expected version from package.json and checks both README claims.

Verification

  • RED: with the original README restored temporarily, npx vitest run test/readme-version.test.ts failed 2/2 assertions against the 2026.6.11 package pin.
  • npm run typecheck
  • npx vitest run test/readme-version.test.ts — 2 passed
  • npx vitest run — 198 passed, 1 skipped
  • just fmt-check
  • git diff --check origin/master...HEAD

pnpm install --frozen-lockfile remains blocked on current master by the missing packages entry tracked in #879 / draft PR #880 (ERROR packages field missing or empty). That unrelated workspace fix is intentionally not duplicated here.

Sensitive paths

None.


Open in Stage

Summary by CodeRabbit

  • Documentation

    • Updated the documented OpenClaw SDK requirement to version 2026.6.11.
    • Updated installation prerequisites to reference the new compatible version.
  • Tests

    • Added validation to ensure the documented SDK version matches the pinned project dependency.

@coderabbitai

coderabbitai Bot commented Jul 15, 2026

Copy link
Copy Markdown

Review Change Stack

Walkthrough

The README now documents OpenClaw 2026.6.11, and a Vitest test verifies that both README references remain aligned with the pinned openclaw devDependency.

Changes

OpenClaw version alignment

Layer / File(s) Summary
Update documented SDK pin
integrations/openclaw/marmot/README.md
Updates the pinned SDK and installation prerequisite from 2026.6.8 to 2026.6.11.
Add README version guard
integrations/openclaw/marmot/test/readme-version.test.ts
Reads the package pin and verifies that the README contains matching SDK and prerequisite references.

Estimated code review effort: 2 (Simple) | ~10 minutes

Possibly related PRs

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Linked Issues check ✅ Passed The README version updates and regression test match the linked issue's requirements and suggested guard.
Out of Scope Changes check ✅ Passed The changes stay within scope, covering only the documentation sync and its version-drift test.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly matches the main change: syncing OpenClaw documentation with the pinned SDK version.
✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch pip/mdk-881

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@stage-review

stage-review Bot commented Jul 15, 2026

Copy link
Copy Markdown

Ready to review this PR? Stage has broken it down into 2 individual chapters for you:

Title
1 Update OpenClaw SDK version in README
2 Add regression test for README versioning
Open in Stage

Chapters generated by Stage for commit 430d119 on Jul 15, 2026 9:38pm UTC.

@agent-p1p

Copy link
Copy Markdown
Contributor Author

Pip adversarial review

Verdict: no blocking findings at 430d119b123905b0e082581aef900055f3c68657.

  • Both README claims now match the exact openclaw pin in package.json and pnpm-lock.yaml: 2026.6.11.
  • The Vitest guard derives the expected value from package.json and covers both documented claims; the old origin/master README lacks all three package-derived substrings.
  • Scope is limited to the README and its regression test. No sensitive paths are touched.
  • Independent checks: npm run typecheck, npm run build, focused Vitest (2/2), full Vitest (198 passed, 1 skipped), and git diff --check all pass.

Findings: 0 blocking, 0 suggestions, 0 nitpicks.

GitHub CI is still in progress; the merge gate must evaluate its final state.

@agent-p1p

Copy link
Copy Markdown
Contributor Author

@coderabbitai review

@coderabbitai

coderabbitai Bot commented Jul 15, 2026

Copy link
Copy Markdown
✅ Action performed

Review finished.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

@agent-p1p
agent-p1p marked this pull request as ready for review July 15, 2026 22:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

OpenClaw README still documents obsolete 2026.6.8 SDK pin

1 participant