From 0421a3b523396277b6ed8fcf082cbade41d70ca2 Mon Sep 17 00:00:00 2001 From: openhands Date: Thu, 5 Mar 2026 14:05:02 +0000 Subject: [PATCH] Update PR review documentation for extensions migration - Update use-case documentation (code-review.mdx) - Update SDK workflow documentation (pr-review.mdx) - Change sdk-repo/sdk-version to extensions-repo/extensions-version - Update related files links to point to extensions repository - Remove references to deleted agent_script.py and prompt.py Related to OpenHands/docs#369 and OpenHands/software-agent-sdk#2282 Co-authored-by: openhands --- openhands/usage/use-cases/code-review.mdx | 14 +++++++------- sdk/guides/github-workflows/pr-review.mdx | 17 +++++++++-------- 2 files changed, 16 insertions(+), 15 deletions(-) diff --git a/openhands/usage/use-cases/code-review.mdx b/openhands/usage/use-cases/code-review.mdx index d6d76beb..6e6ff334 100644 --- a/openhands/usage/use-cases/code-review.mdx +++ b/openhands/usage/use-cases/code-review.mdx @@ -103,9 +103,9 @@ Choose between two review styles: The workflow uses a reusable composite action from the Software Agent SDK that handles all the setup automatically: -- Checking out the SDK at the specified version +- Checking out the extensions repository at the specified version - Setting up Python and dependencies -- Running the PR review agent +- Running the PR review agent (from extensions repo) - Uploading logs as artifacts ### Action Inputs @@ -115,13 +115,13 @@ The workflow uses a reusable composite action from the Software Agent SDK that h | `llm-model` | LLM model to use | Yes | - | | `llm-base-url` | LLM base URL (for custom endpoints) | No | `''` | | `review-style` | Review style: `standard` or `roasted` | No | `roasted` | -| `sdk-version` | Git ref for SDK (tag, branch, or commit SHA) | No | `main` | -| `sdk-repo` | SDK repository (owner/repo) | No | `OpenHands/software-agent-sdk` | +| `extensions-version` | Git ref for extensions (tag, branch, or commit SHA) | No | `main` | +| `extensions-repo` | Extensions repository (owner/repo) | No | `OpenHands/extensions` | | `llm-api-key` | LLM API key | Yes | - | | `github-token` | GitHub token for API access | Yes | - | -Use `sdk-version` to pin to a specific version tag (e.g., `v1.0.0`) for production stability, or use `main` to always get the latest features. +Use `extensions-version` to pin to a specific version tag (e.g., `v1.0.0`) for production stability, or use `main` to always get the latest features. The extensions repository contains the PR review plugin scripts. ## Customization @@ -190,8 +190,8 @@ Customize the workflow by modifying the action inputs: llm-base-url: https://your-llm-proxy.example.com # Switch to "roasted" style for brutally honest reviews review-style: roasted - # Pin to a specific SDK version for stability - sdk-version: main + # Pin to a specific extensions version for stability + extensions-version: main # Secrets llm-api-key: ${{ secrets.LLM_API_KEY }} github-token: ${{ secrets.GITHUB_TOKEN }} diff --git a/sdk/guides/github-workflows/pr-review.mdx b/sdk/guides/github-workflows/pr-review.mdx index 00f43d0f..4b99d637 100644 --- a/sdk/guides/github-workflows/pr-review.mdx +++ b/sdk/guides/github-workflows/pr-review.mdx @@ -168,8 +168,8 @@ jobs: llm-base-url: '' # Review style: roasted (other option: standard) review-style: roasted - # SDK version to use (version tag or branch name) - sdk-version: main + # Extensions version to use (version tag or branch name) + extensions-version: main # Secrets llm-api-key: ${{ secrets.LLM_API_KEY }} github-token: ${{ secrets.GITHUB_TOKEN }} @@ -182,14 +182,15 @@ jobs: | `llm-model` | LLM model to use | Yes | - | | `llm-base-url` | LLM base URL (optional) | No | `''` | | `review-style` | Review style: 'standard' or 'roasted' | No | `roasted` | -| `sdk-version` | Git ref for SDK (tag, branch, or commit SHA) | No | `main` | -| `sdk-repo` | SDK repository (owner/repo) | No | `OpenHands/software-agent-sdk` | +| `extensions-version` | Git ref for extensions (tag, branch, or commit SHA) | No | `main` | +| `extensions-repo` | Extensions repository (owner/repo) | No | `OpenHands/extensions` | | `llm-api-key` | LLM API key | Yes | - | | `github-token` | GitHub token for API access | Yes | - | ## Related Files -- [Agent Script](https://github.com/OpenHands/software-agent-sdk/blob/main/examples/03_github_workflows/02_pr_review/agent_script.py) -- [Workflow File](https://github.com/OpenHands/software-agent-sdk/blob/main/examples/03_github_workflows/02_pr_review/workflow.yml) -- [Prompt Template](https://github.com/OpenHands/software-agent-sdk/blob/main/examples/03_github_workflows/02_pr_review/prompt.py) -- [Composite Action](https://github.com/OpenHands/software-agent-sdk/blob/main/.github/actions/pr-review/action.yml) +- [PR Review Plugin](https://github.com/OpenHands/extensions/tree/main/plugins/pr-review) - Complete plugin with scripts and skills (in extensions repo) +- [Agent Script](https://github.com/OpenHands/extensions/blob/main/plugins/pr-review/scripts/agent_script.py) - Main review agent script +- [Prompt Template](https://github.com/OpenHands/extensions/blob/main/plugins/pr-review/scripts/prompt.py) - Review prompt template +- [Workflow File](https://github.com/OpenHands/software-agent-sdk/blob/main/examples/03_github_workflows/02_pr_review/workflow.yml) - Example workflow +- [Composite Action](https://github.com/OpenHands/software-agent-sdk/blob/main/.github/actions/pr-review/action.yml) - Reusable GitHub Action