chore: refresh stale 1.22.1 doc examples after agent-server bump to 1.23.0#694
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
all-hands-bot
left a comment
all-hands-bot
left a comment
There was a problem hiding this comment.
Taste Rating: 🟢 Good taste - Clean documentation refresh with regression test
[RISK ASSESSMENT]
- [Overall PR]
⚠️ Risk Assessment: 🟢 LOW
Documentation-only changes with a new drift-detection test. No code behavior changes, no dependencies affected, no breaking changes.
VERDICT:
✅ Worth merging: Solves the real problem of doc drift and adds a test to prevent it from happening again.
KEY INSIGHT:
Adding the drift-detection test is the right pragmatic solution - it makes this a one-time problem instead of a recurring maintenance burden.
Was this automated review useful? React with 👍 or 👎 to this review to help us measure review quality.
Workflow run: https://github.com/OpenHands/agent-canvas/actions/runs/26207753818
📸 Snapshot Test Report✅ All snapshots match the main branch baselines.
✅ Unchanged snapshots (73)
Generated by the Snapshot Tests workflow. This comment was created by an AI agent (OpenHands) on behalf of the repo maintainers. |
2 participants
Why
Description
PR #670 bumped
versions.agentServerinconfig/defaults.jsonfrom1.22.1to1.23.0(and updated the default-version test assertions in__tests__/scripts/dev-safe.test.ts), but left several JSDoc andAGENTS.mdexamples still mentioning1.22.1. This drift makes the docs misleading for contributors who are pinning a specific version or running the version-sync script.Following the pattern set by agent-canvas PR #477 — which includes "refreshing documentation examples throughout the repository" as part of every version bump — refresh the stale references so they match the central pin.
versions.automationSdk(1.22.1) is intentionally left alone — it records the SDK version that the releasedopenhands-automationPyPI package was built against and may lagversions.agentServerby design (see the header comment inscripts/check-sdk-version-sync.mjs).Acceptance criteria
AGENTS.mdreferences to the agent-server default version read1.23.0.scripts/dev-safe.mjs,scripts/check-sdk-version-sync.mjs, andscripts/check-acp-providers-sync.mjsJSDoc/comment examples read1.23.0.versions.agentServerinconfig/defaults.json.versions.automationSdkis not touched.node scripts/check-sdk-version-sync.mjs) still passes.Out of scope
versions.automationSdk— separate concern, tied to the released automation PyPI package.1.18.0examples in.env.sample/DEVELOPMENT.md— these are unrelated env-override illustrations, not default-version references.dev-safe.test.ts/check-sdk-version-sync.test.ts/option-service.test.tsthat pass arbitrary versions to assert env-override behavior.Links
Summary
versions.agentServerto1.23.0inconfig/defaults.jsonbut did not refresh the example version strings scattered acrossAGENTS.mdand several script JSDocs. This PR completes that refresh.__tests__/scripts/docs-version-sync.test.ts) so the next bump cannot silently leave docs behind.versions.automationSdkis intentionally left at1.22.1— it tracks the releasedopenhands-automationPyPI package's SDK dependency and is allowed to lagversions.agentServer.Files changed
AGENTS.mdOH_AGENT_SERVER_VERSIONenv-var example + "Default: released PyPI version" sentencescripts/dev-safe.mjsOH_AGENT_SERVER_VERSIONscripts/check-sdk-version-sync.mjsscripts/check-acp-providers-sync.mjs--sdk-refusage example__tests__/scripts/docs-version-sync.test.tsconfig/defaults.jsonWhy this matters
The previous bump pattern (agent-canvas #477) explicitly included "refreshing documentation examples throughout the repository" as part of every version bump. Without that step, the canonical pin in
config/defaults.jsonand the human-readable docs drift apart, which is exactly what happened between PR #670 and this PR.The new test reads
versions.agentServerfromconfig/defaults.jsonat runtime and asserts every documented example matches, so the failure mode becomes a fast unit-test red instead of a silent doc rot.Out of scope
versions.automationSdk(intentionally lags — seescripts/check-sdk-version-sync.mjsheader).1.18.0examples in.env.sampleandDEVELOPMENT.md— these illustrate env-override usage and are not default-version references."1.18.0"strings indev-safe.test.ts).Issue Number
Resolves #693
Type
Notes
Related
main): feat: use async conversations and interrupt endpoint for local mode #670🐳 Docker images for this PR
• GHCR package: https://github.com/OpenHands/agent-canvas/pkgs/container/agent-canvas
ghcr.io/openhands/agent-canvasghcr.io/openhands/agent-server:1.23.0-pythonopenhands-automation==1.0.0a330706eb304206cdfc5de8b4ab507686e01a83aadPull (multi-arch manifest)
# Multi-arch manifest — Docker automatically pulls the correct architecture docker pull ghcr.io/openhands/agent-canvas:sha-30706ebRun
All tags pushed for this build
About Multi-Architecture Support
sha-30706eb) is a multi-arch manifest supporting both amd64 and arm64sha-30706eb-amd64) are also available if needed