Repository navigation
refactor: Use composite GitHub Action for PR review workflow #1927
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||||
|---|---|---|---|---|---|---|---|---|
| @@ -0,0 +1,129 @@ | ||||||||
| --- | ||||||||
| name: OpenHands PR Review | ||||||||
| description: Automated PR review using OpenHands agent | ||||||||
| author: OpenHands | ||||||||
|
|
||||||||
| branding: | ||||||||
| icon: code | ||||||||
| color: blue | ||||||||
|
|
||||||||
| inputs: | ||||||||
| llm-model: | ||||||||
| description: LLM model to use for the review | ||||||||
| required: false | ||||||||
| default: anthropic/claude-sonnet-4-5-20250929 | ||||||||
| llm-base-url: | ||||||||
| description: LLM base URL (optional, for custom LLM endpoints) | ||||||||
| required: false | ||||||||
| default: '' | ||||||||
| review-style: | ||||||||
| description: "Review style: 'standard' (balanced review covering style, readability, and security) or 'roasted' (Linus Torvalds-style brutally honest | ||||||||
| feedback focusing on data structures, simplicity, and pragmatism)" | ||||||||
| required: false | ||||||||
| default: roasted | ||||||||
| sdk-repo: | ||||||||
| description: GitHub repository for the SDK (owner/repo) | ||||||||
| required: false | ||||||||
| default: OpenHands/software-agent-sdk | ||||||||
| sdk-version: | ||||||||
| description: Git ref to use for the SDK (tag, branch, or commit SHA, e.g., v1.0.0, main, or abc1234) | ||||||||
| required: false | ||||||||
| default: main | ||||||||
|
enyst marked this conversation as resolved.
|
||||||||
| llm-api-key: | ||||||||
| description: LLM API key (required) | ||||||||
| required: true | ||||||||
| github-token: | ||||||||
| description: GitHub token for API access (required) | ||||||||
| required: true | ||||||||
|
|
||||||||
| runs: | ||||||||
| using: composite | ||||||||
| steps: | ||||||||
| - name: Checkout software-agent-sdk repository | ||||||||
| uses: actions/checkout@v4 | ||||||||
| with: | ||||||||
| repository: ${{ inputs.sdk-repo }} | ||||||||
| ref: ${{ inputs.sdk-version }} | ||||||||
|
Collaborator
There was a problem hiding this comment. 🟡 Suggestion: Consider documenting the security implications of the |
||||||||
| path: software-agent-sdk | ||||||||
|
|
||||||||
| - name: Checkout PR repository | ||||||||
| uses: actions/checkout@v4 | ||||||||
| with: | ||||||||
| repository: ${{ github.event.pull_request.head.repo.full_name }} | ||||||||
| ref: ${{ github.event.pull_request.head.ref }} | ||||||||
| fetch-depth: 0 | ||||||||
| persist-credentials: false | ||||||||
| path: pr-repo | ||||||||
|
|
||||||||
| - name: Set up Python | ||||||||
| uses: actions/setup-python@v5 | ||||||||
| with: | ||||||||
| python-version: '3.12' | ||||||||
|
|
||||||||
| - name: Install uv | ||||||||
| uses: astral-sh/setup-uv@v6 | ||||||||
| with: | ||||||||
| enable-cache: true | ||||||||
|
|
||||||||
| - name: Install GitHub CLI | ||||||||
| shell: bash | ||||||||
| run: | | ||||||||
| sudo apt-get update | ||||||||
| sudo apt-get install -y gh | ||||||||
|
|
||||||||
| - name: Install OpenHands dependencies | ||||||||
| shell: bash | ||||||||
| run: | | ||||||||
|
Collaborator
There was a problem hiding this comment. 🟢 Nit: Using
Suggested change
|
||||||||
| uv pip install --system ./software-agent-sdk/openhands-sdk ./software-agent-sdk/openhands-tools | ||||||||
|
|
||||||||
| - name: Check required configuration | ||||||||
| shell: bash | ||||||||
| env: | ||||||||
| LLM_API_KEY: ${{ inputs.llm-api-key }} | ||||||||
| GITHUB_TOKEN: ${{ inputs.github-token }} | ||||||||
| run: | | ||||||||
| if [ -z "$LLM_API_KEY" ]; then | ||||||||
| echo "Error: llm-api-key is required." | ||||||||
| exit 1 | ||||||||
| fi | ||||||||
| if [ -z "$GITHUB_TOKEN" ]; then | ||||||||
| echo "Error: github-token is required." | ||||||||
| exit 1 | ||||||||
| fi | ||||||||
|
|
||||||||
| echo "PR Number: ${{ github.event.pull_request.number }}" | ||||||||
| echo "PR Title: ${{ github.event.pull_request.title }}" | ||||||||
| echo "Repository: ${{ github.repository }}" | ||||||||
| echo "SDK Version: ${{ inputs.sdk-version }}" | ||||||||
| echo "LLM model: ${{ inputs.llm-model }}" | ||||||||
| if [ -n "${{ inputs.llm-base-url }}" ]; then | ||||||||
| echo "LLM base URL: ${{ inputs.llm-base-url }}" | ||||||||
| fi | ||||||||
|
|
||||||||
| - name: Run PR review | ||||||||
| shell: bash | ||||||||
| env: | ||||||||
| LLM_MODEL: ${{ inputs.llm-model }} | ||||||||
| LLM_BASE_URL: ${{ inputs.llm-base-url }} | ||||||||
|
Collaborator
There was a problem hiding this comment. 🟢 Nit: Empty string for |
||||||||
| REVIEW_STYLE: ${{ inputs.review-style }} | ||||||||
| LLM_API_KEY: ${{ inputs.llm-api-key }} | ||||||||
| GITHUB_TOKEN: ${{ inputs.github-token }} | ||||||||
| PR_NUMBER: ${{ github.event.pull_request.number }} | ||||||||
| PR_TITLE: ${{ github.event.pull_request.title }} | ||||||||
| PR_BODY: ${{ github.event.pull_request.body }} | ||||||||
| PR_BASE_BRANCH: ${{ github.event.pull_request.base.ref }} | ||||||||
| PR_HEAD_BRANCH: ${{ github.event.pull_request.head.ref }} | ||||||||
| REPO_NAME: ${{ github.repository }} | ||||||||
| run: | | ||||||||
| cd pr-repo | ||||||||
| uv run python ../software-agent-sdk/examples/03_github_workflows/02_pr_review/agent_script.py | ||||||||
|
|
||||||||
| - name: Upload logs as artifact | ||||||||
| uses: actions/upload-artifact@v4 | ||||||||
| if: always() | ||||||||
| with: | ||||||||
| name: openhands-pr-review-logs | ||||||||
| path: | | ||||||||
| *.log | ||||||||
| output/ | ||||||||
|
Collaborator
There was a problem hiding this comment. 🔴 Critical: The artifact paths are incorrect. The script runs with Fix:
Suggested change
|
||||||||
| retention-days: 7 | ||||||||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
xingyaoww marked this conversation as resolved.
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -4,7 +4,8 @@ This example demonstrates how to set up a GitHub Actions workflow for automated | |
|
|
||
| ## Files | ||
|
|
||
| - **`action.yml`**: Symlink to the composite GitHub Action (`.github/actions/pr-review/action.yml`) | ||
| - **`workflow.yml`**: Example GitHub Actions workflow file that uses the composite action | ||
| - **`agent_script.py`**: Python script that runs the OpenHands agent for PR review | ||
| - **`prompt.py`**: The prompt asking the agent to write the PR review | ||
| - **`README.md`**: This documentation file | ||
|
|
@@ -32,6 +33,7 @@ This example demonstrates how to set up a GitHub Actions workflow for automated | |
| - Potential issues and security concerns | ||
| - Specific improvement suggestions | ||
| - **GitHub API Integration**: Uses the GitHub API to post inline review comments directly on specific lines of code | ||
| - **Version Control**: Use `sdk-version` to pin to a specific version tag or branch | ||
|
|
||
| ## Setup | ||
|
|
||
|
|
@@ -54,18 +56,24 @@ Set the following secrets in your GitHub repository settings: | |
|
|
||
| ### 3. Customize the workflow (optional) | ||
|
|
||
| Edit `.github/workflows/pr-review-by-openhands.yml` to customize the inputs: | ||
|
|
||
| ```yaml | ||
| - name: Run PR Review | ||
| uses: ./.github/actions/pr-review | ||
| with: | ||
| # LLM configuration | ||
| llm-model: anthropic/claude-sonnet-4-5-20250929 | ||
| llm-base-url: '' | ||
| # Review style: roasted (other option: standard) | ||
| review-style: roasted | ||
| # SDK git ref to use (tag, branch, or commit SHA, e.g., 'v1.0.0', 'main', or 'abc1234') | ||
| sdk-version: main | ||
| # Optional: override the SDK repo (owner/repo) if you forked it | ||
| sdk-repo: OpenHands/software-agent-sdk | ||
| # Secrets | ||
| llm-api-key: ${{ secrets.LLM_API_KEY }} | ||
| github-token: ${{ secrets.GITHUB_TOKEN }} | ||
| ``` | ||
|
|
||
| ### 4. Create the review label | ||
|
|
@@ -101,3 +109,78 @@ There are two ways to trigger an automated review of a pull request: | |
| 5. Review comments will be posted to the PR when complete | ||
|
|
||
| **Note**: Both methods require write access to the repository, ensuring only authorized users can trigger the AI review. | ||
|
|
||
| ## Customizing the Code Review | ||
|
|
||
| Instead of forking the `agent_script.py`, you can customize the code review behavior by adding a `.openhands/skills/code-review.md` file to your repository. This is the **recommended approach** for customization. | ||
|
|
||
| ### How It Works | ||
|
|
||
| The PR review agent uses skills from the [OpenHands/skills](https://github.com/OpenHands/skills) repository by default. When you add a `.openhands/skills/code-review.md` file to your repository, it **overrides** the default skill with your custom guidelines. | ||
|
|
||
| ### Example: Custom Code Review Skill | ||
|
|
||
| Create `.openhands/skills/code-review.md` in your repository: | ||
|
|
||
| ```markdown | ||
| --- | ||
| name: code-review | ||
| description: Custom code review guidelines for my project | ||
| triggers: | ||
| - /codereview | ||
| --- | ||
|
|
||
| # My Project Code Review Guidelines | ||
|
|
||
| You are a code reviewer for this project. Follow these guidelines: | ||
|
|
||
| ## Review Decisions | ||
|
|
||
| - **APPROVE** straightforward changes (config updates, typo fixes, documentation) | ||
| - **COMMENT** when you have feedback or concerns | ||
|
Member
There was a problem hiding this comment. Out of curiosity, why not
Contributor
Author
There was a problem hiding this comment. Because then itll be slightlytricky for all-hands-bot to re-review and unblock again. in general, i dont want to see reviewer bot is blocking our PR with some trivialsuggestion 😓
Member
There was a problem hiding this comment. TBH in my experience so far, my concern is more the other way around: if it has That's why the idea I brought in slack about a workflow forcing it to address all comments, no matter how trivial, to make it think about them before dismissing them -that feels like a thing my yolo repos need 😅 I feel maybe it's good to keep it simpler... I'm not sure it'd be tricky the other way around, but maybe it would need to re-run in the same session, not from github actions with fresh context every time maybe (my little agents were run from CLI runs on my machine, and re-reviewed from the same session)
Contributor
Author
There was a problem hiding this comment. good point, maybe we can leave it as customizable for each repo. which probably outof the conext of this PR; but yeah agree on the blocker workflow |
||
|
|
||
| ## What to Check | ||
|
|
||
| - Code follows our project conventions | ||
| - Tests are included for new functionality | ||
| - No security vulnerabilities introduced | ||
| - Documentation is updated if needed | ||
|
|
||
| ## Communication Style | ||
|
|
||
| - Be direct and constructive | ||
| - Use GitHub suggestion syntax for code fixes | ||
| - Approve quickly when code is good | ||
| ``` | ||
|
|
||
| ### Benefits of Custom Skills | ||
|
|
||
| 1. **No forking required**: Keep using the official SDK while customizing behavior | ||
| 2. **Version controlled**: Your review guidelines live in your repository | ||
| 3. **Easy updates**: SDK updates don't overwrite your customizations | ||
| 4. **Team alignment**: Everyone uses the same review standards | ||
|
|
||
| ### Reference Example | ||
|
|
||
| See the [software-agent-sdk's own code-review skill](https://github.com/OpenHands/software-agent-sdk/blob/main/.openhands/skills/code-review.md) for a complete example of a custom code review skill. | ||
|
|
||
| ## Composite Action | ||
|
|
||
| This workflow uses a reusable composite action located at `.github/actions/pr-review/action.yml` in the software-agent-sdk repository. The composite action handles: | ||
|
enyst marked this conversation as resolved.
|
||
|
|
||
| - Checking out the SDK at the specified version | ||
| - Setting up Python and dependencies | ||
| - Running the PR review agent | ||
| - Uploading logs as artifacts | ||
|
|
||
| ### Action Inputs | ||
|
|
||
| | Input | Description | Required | Default | | ||
| |-------|-------------|----------|---------| | ||
| | `llm-model` | LLM model to use | No | `anthropic/claude-sonnet-4-5-20250929` | | ||
| | `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` | | ||
| | `llm-api-key` | LLM API key | Yes | - | | ||
| | `github-token` | GitHub token for API access | Yes | - | | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| ../../../.github/actions/pr-review/action.yml |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.