Skip to content

automation: Docs update for OpenHands v1.20.0 release #808

Description

@all-hands-bot

Release

Release summary

OpenHands v1.20.0 introduces three user-facing features and two maintenance changes. The features allow users to select which secrets are available to an agent profile, forward Docker conversation runtime settings from Canvas to its bundled Agent Server, and select saved agent profiles during automation setup. The maintenance items isolate Mock-LLM test profiles from ambient secrets and bump released agent runtime dependencies (Agent Server 1.49.1, TypeScript client 1.49.1, Automation 1.13.1, Extensions 0.22.1).

Documentation review checklist

  • feat(agent-profiles): select secrets available to a profile (PR #17237) — documentation needed. Users can now choose which saved secrets an agent profile can access (all, none, or selected names) via the profile editor in Settings > Agent. The control appears only when Agent Server advertises profile_secret_scope_v1. The agent-profiles docs page (/openhands/usage/agent-canvas/agent-profiles) currently has no mention of secret scoping. Recommend documenting the secret scope picker, the profile_secret_scope_v1 capability gate, and the behavior of preserved/deleted secret references. Source: feat(agent-profiles): select secrets available to a profile OpenHands#17237
  • feat: forward Docker conversation runtime settings (PR #17462) — documentation needed. Canvas now forwards six conversation-runtime settings (runtime, image, memory, CPU, PID limits, startup timeout) to its bundled Agent Server when the operator explicitly sets them, enabling OH_CONVERSATION_RUNTIME=docker. The environment-variables docs page (/openhands/usage/environment-variables) lists runtime-related variables but does not document the Canvas-to-Agent-Server forwarding behavior. Recommend documenting the forwarded settings and how OH_CONVERSATION_RUNTIME=docker works in a local Canvas deployment. Source: feat: forward Docker conversation runtime settings OpenHands#17462
  • feat(automations): select saved agent profiles (PR #17396) — documentation needed. Users can now select a saved agent profile during automation setup and editing when the backend advertises agent-profile support. When a profile is selected, the stable agent_profile_id is sent and the legacy model field is omitted. The prebuilt-automations docs page (/openhands/usage/agent-canvas/prebuilt-automations) currently mentions an LLM profile dropdown but not agent profile selection for automations. Recommend documenting the agent profile selector, the agent_profile_id field, and the behavior when a saved selection becomes unavailable. Source: feat(automations): select saved agent profiles OpenHands#17396
  • test: isolate Mock-LLM profiles from ambient secrets (PR #17482) — probably no documentation change. This is a test-only fix that sets secret_refs: [] in the Mock-LLM E2E test helper to avoid environment-dependent secret lookups. No user-facing behavior change. Source: test: isolate Mock-LLM profiles from ambient secrets OpenHands#17482
  • chore: bump released agent runtime dependencies (PR #17489) — needs maintainer confirmation. This bumps Agent Server to 1.49.1, TypeScript client to 1.49.1, Automation to 1.13.1, and Extensions to 0.22.1. If the docs reference specific version numbers for these dependencies (e.g., in setup or compatibility pages), those references may need updating. The AGENTS.md in the OpenHands repo was also modified. Source: chore: bump released agent runtime dependencies OpenHands#17489

Pull request review

Human testing required

  • Agent profile secret scoping (PR #17237): In a Canvas instance connected to an Agent Server that advertises profile_secret_scope_v1, create or edit an agent profile in Settings > Agent and verify the secret-scope picker appears. Select "none" and confirm the profile cannot access any saved secrets. Select specific secret names and confirm only those are available. Verify that deleted secret references are preserved (not silently removed).
  • Docker conversation runtime forwarding (PR #17462): Set OH_CONVERSATION_RUNTIME=docker (and optionally OH_CONVERSATION_RUNTIME_IMAGE, memory/CPU/PID limits, startup timeout) in a local Canvas environment launched via dev-safe.mjs. Verify the bundled Agent Server starts in Docker mode and the forwarded settings take effect.
  • Automation agent profile selection (PR #17396): In a Canvas instance with agent-profile support, create a new automation and verify the agent profile selector appears. Select a saved profile and confirm agent_profile_id is sent. Edit an existing automation and verify the selector pre-selects the current profile. Test the case where a selected profile has been deleted and confirm it remains visible rather than silently switching.

Suggested documentation locations

  • /openhands/usage/agent-canvas/agent-profiles — Add a section on secret scoping for agent profiles, covering the picker UI, the profile_secret_scope_v1 capability gate, and preserved/deleted reference behavior. Rationale: this is the canonical page for agent profile management and currently has no mention of secrets.
  • /openhands/usage/environment-variables — Document the six forwarded Docker conversation-runtime settings (OH_CONVERSATION_RUNTIME, OH_CONVERSATION_RUNTIME_IMAGE, memory/CPU/PID limits, startup timeout) and how they propagate from Canvas to the bundled Agent Server. Rationale: this page already lists runtime-related variables.
  • /openhands/usage/agent-canvas/prebuilt-automations — Add documentation for agent profile selection during automation setup and editing. Rationale: this page already covers LLM profile selection for automations; agent profile selection is the natural extension.
  • /openhands/usage/agent-canvas/release-notes/ — A new v1.20.0.mdx release notes page following the existing format (see v1.18.0.mdx). Rationale: prior releases have dedicated release-notes pages.
  • Needs maintainer triage for the dependency version bumps in PR #17489 — check if any docs reference specific Agent Server, TypeScript client, Automation, or Extensions version numbers.

Source links

This issue was created by an AI agent (OpenHands) on behalf of the user.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    ready-for-humanA draft documentation pull request is ready for human review.

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions