oz-agent-action/consumer-workflows/review-pr.yml at main · warpdotdev/oz-agent-action · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
# Template workflow generated from examples/review-pr.yml.
# Copy this file into .github/workflows/ in your own repository and customize as needed.
# Do not edit this file in-place in this repo; instead, edit the source example and run:
# npm run gen-workflows

# ======================================================================================
# Workflow: Auto PR Review
# ======================================================================================
# Usage:
#   - Runs automatically when a Pull Request is opened or marked ready for review.
#   - Analyzes the diff of the PR.
#
# Setup:
#   - Ensure WARP_API_KEY is set in Repository Secrets.
#   - The Agent needs read access to contents and write access to pull-requests.
#
# Expected Output:
#   - Inline comments on the PR diff highlighting potential bugs, security issues, or style improvements.
#   - A general summary comment if applicable.
#
# When to use:
#   - Use this to get immediate feedback on code changes before human review.
# ======================================================================================
name: Auto PR Review
on:
  pull_request:
    types:
      - opened
      - ready_for_review
jobs:
  review_pr:
    uses: warpdotdev/oz-agent-action/.github/workflows/review-pr.yml@v1
    with:
      # These inputs are all optional
      profile: ''
      model: ''
      name: ''
      mcp: ''
      skill: ''
    secrets:
      WARP_API_KEY: ${{ secrets.WARP_API_KEY }}