Skip to content

Commit b4aba22

Browse files
docs: slim verification-stack Layer 2 section to lightweight links
Full setup instructions now live in code-review.mdx and qa-changes.mdx. Verification stack page links out to them instead of duplicating content. Co-authored-by: openhands <openhands@all-hands.dev>
1 parent 4bb5ac2 commit b4aba22

1 file changed

Lines changed: 3 additions & 69 deletions

File tree

openhands/usage/use-cases/verification-stack.mdx

Lines changed: 3 additions & 69 deletions
Original file line numberDiff line numberDiff line change
@@ -48,76 +48,10 @@ For technical details on how the critic model works, see our paper: [A Rubric-Su
4848

4949
The repo-level verifier consists of two components — a [code review agent](/openhands/usage/use-cases/code-review) and a [QA agent](/openhands/usage/use-cases/qa-changes) — both available as plugins in the [OpenHands/extensions](https://github.com/OpenHands/extensions) repository.
5050

51-
### Option A: GitHub Actions
52-
53-
Add the ReviewBot directly to your GitHub Actions workflow. This runs the code review (and optionally QA) as part of your CI pipeline on every PR.
54-
55-
<Steps>
56-
<Step title="Create a bot account">
57-
Create a bot account under your GitHub organization (e.g., `your-org-bot`). This account will post review comments and approve/request changes on PRs. Grant it write access and the ability to approve PRs on your repository.
58-
</Step>
59-
60-
<Step title="Configure secrets">
61-
In your repository's **Settings → Secrets and variables → Actions**, add:
62-
- **`LLM_API_KEY`**: Your LLM API key
63-
- **`BOT_GITHUB_TOKEN`**: A GitHub token for the bot account (if you want reviews posted by the bot rather than the default `GITHUB_TOKEN`)
64-
</Step>
65-
66-
<Step title="Add the workflow">
67-
Create `.github/workflows/review-bot.yml`:
68-
69-
```yaml
70-
name: ReviewBot
71-
on:
72-
pull_request:
73-
types: [opened, ready_for_review, synchronize]
74-
75-
jobs:
76-
review:
77-
runs-on: ubuntu-latest
78-
if: github.event.pull_request.draft == false
79-
steps:
80-
- name: Run PR Review
81-
uses: OpenHands/extensions/plugins/pr-review@main
82-
with:
83-
llm-model: anthropic/claude-sonnet-4-5-20250929
84-
llm-api-key: ${{ secrets.LLM_API_KEY }}
85-
github-token: ${{ secrets.BOT_GITHUB_TOKEN || secrets.GITHUB_TOKEN }}
86-
```
87-
</Step>
88-
</Steps>
89-
90-
**Trade-offs:** Full control over when and how the bot runs. However, it requires per-repository configuration — every new repo needs its own workflow file, and keeping them in sync requires maintenance.
91-
92-
For the complete configuration reference (trigger customization, ACP mode, sub-agents, custom review guidelines), see the [Automated Code Review](/openhands/usage/use-cases/code-review) page.
93-
94-
### Option B: OpenHands Automations (Beta)
51+
For full setup instructions, see:
9552

96-
<Warning>
97-
OpenHands Automations is currently an experimental beta feature. The API and configuration format may change.
98-
</Warning>
99-
100-
The alternative is using [OpenHands Automations](/openhands/usage/automations/overview), our event-triggered automation system. With Automations, you define the trigger once and it covers all repositories the bot account has access to — no per-repo workflow files needed.
101-
102-
<Steps>
103-
<Step title="Create a bot account on OpenHands Cloud">
104-
Log in to [OpenHands Cloud](https://app.all-hands.dev) with your organization's bot GitHub account.
105-
</Step>
106-
107-
<Step title="Connect GitHub">
108-
Connect the bot account's GitHub to OpenHands Cloud via the [GitHub installation](/openhands/usage/cloud/github-installation) flow.
109-
</Step>
110-
111-
<Step title="Create the automation">
112-
Log in as the bot account and instruct the agent to set up the automation:
113-
114-
```
115-
Create an OpenHands Cloud automation using the Plugin Preset that automatically reviews pull requests. Use the pr-review plugin from github:OpenHands/extensions (repo_path: plugins/pr-review). Trigger it on pull_request.opened and pull_request.ready_for_review events for the repository YOUR_ORG/YOUR_REPO, excluding draft PRs. Set timeout to 3600 seconds. Use this exact prompt for the automation: "Review the pull request from the GitHub event payload using the pr-review plugin. Post a comprehensive code review on GitHub with inline comments on specific changed lines where appropriate, and a concise overall summary. Avoid duplicating existing unresolved review comments. Include a brief note that the review was generated by an AI agent (OpenHands) on behalf of the user through OpenHands Automation."
116-
```
117-
</Step>
118-
</Steps>
119-
120-
**Trade-offs:** Simpler to set up and maintain — define it once and it covers all repos. It also leverages the full OpenHands runtime (browser, tools, sandbox), which GitHub Actions cannot.
53+
- **[Automated Code Review](/openhands/usage/use-cases/code-review)** — GitHub Actions and OpenHands Automations setup for the ReviewBot
54+
- **[Automated QA Testing](/openhands/usage/use-cases/qa-changes)** — Setup for the QA agent
12155

12256
## Closing the Loop: The Iterate Skill
12357

0 commit comments

Comments
 (0)