|
| 1 | +--- |
| 2 | +title: AI Code Review Agent |
| 3 | +sidebarTitle: AI Code Review Agent |
| 4 | +--- |
| 5 | + |
| 6 | +<Note> |
| 7 | +This agent sends data to OpenAI (through an API key you supply) to perform code reviews. This data includes code from the PR being reviewed, as well as additional relevant context from your |
| 8 | +codebase that the agent may fetch to perform the review. |
| 9 | +</Note> |
| 10 | + |
| 11 | +This agent provides codebase-aware reviews for your PRs. For each diff, this agent fetches relevant context from Sourcebot and feeds it into an LLM for a detailed review of your changes. |
| 12 | + |
| 13 | +The AI Code Review Agent is open source and packaged in [Sourcebot](https://github.com/sourcebot-dev/sourcebot). To get started using this agent, [deploy Sourcebot](/self-hosting/overview) |
| 14 | +and then follow the configuration instructions below. |
| 15 | + |
| 16 | + |
| 17 | + |
| 18 | +# Configure |
| 19 | + |
| 20 | +This agent currently only supports reviewing GitHub PRs. You configure the agent by creating a GitHub app, installing it into your GitHub organization, and then giving your app info to Sourcebot. |
| 21 | + |
| 22 | +Before you get started, make sure you have an OpenAPI account that you can create an OpenAPI key with. |
| 23 | + |
| 24 | +<Steps> |
| 25 | + <Step title="Register a GitHub app"> |
| 26 | + Follow the official GitHub guide for [registering a GitHub app](https://docs.github.com/en/apps/creating-github-apps/registering-a-github-app/registering-a-github-app) |
| 27 | + |
| 28 | + - GitHub App name: You can make this whatever you want (ex. Sourcebot Review Agent) |
| 29 | + - Homepage URL: You can make this whatever you want (ex. https://www.sourcebot.dev/) |
| 30 | + - Webhook URL (**IMPORTANT**): You must set this to point to your Sourcebot deployment at /api/webhook (ex. https://sourcebot.aperture.com/api/webhook). Your Sourcebot deployment must be able to accept requests from GitHub |
| 31 | + (either github.com or your self-hosted enterprise server) for this to work. If you're running Sourcebot locally, you can [use smee](https://docs.github.com/en/apps/creating-github-apps/writing-code-for-a-github-app/quickstart#step-2-get-a-webhook-proxy-url) to [forward webhooks](https://docs.github.com/en/apps/creating-github-apps/writing-code-for-a-github-app/quickstart#step-6-start-your-server) to your local deployment. |
| 32 | + - Permissions |
| 33 | + - Pull requests: Read & Write |
| 34 | + - Issues: Read & Write |
| 35 | + - Contents: Read |
| 36 | + - Events: |
| 37 | + - Pull request |
| 38 | + - Issue comment |
| 39 | + </Step> |
| 40 | + <Step title="Install the GitHub app in your organization"> |
| 41 | + Navigate to your new [GitHub app's page](https://docs.github.com/en/apps/creating-github-apps/writing-code-for-a-github-app/quickstart#navigate-to-your-app-settings) and press `Install` |
| 42 | + </Step> |
| 43 | + <Step title="Configure the environment variables in Sourcebot"> |
| 44 | + Sourcebot requires the following environment variables to begin reviewing PRs through your new GitHub app: |
| 45 | + |
| 46 | + - `GITHUB_APP_ID`: The client ID of your GitHub app. Can be found in your [app settings](https://docs.github.com/en/apps/creating-github-apps/writing-code-for-a-github-app/quickstart#navigate-to-your-app-settings) |
| 47 | + - `GITHUB_APP_WEBHOOK_SECRET`: A random webhook secret that you've set in your [app settings](https://docs.github.com/en/apps/creating-github-apps/writing-code-for-a-github-app/quickstart#navigate-to-your-app-settings). This can be anything (ex. `python -c "import secrets; print(secrets.token_hex(10))"` to generate a random secret) |
| 48 | + - `GITHUB_APP_PRIVATE_KEY_PATH`: The path to your app's private key. If you're running Sourcebot from a container, this is the path to this file from within your container |
| 49 | + (ex `/data/review-agent-key.pem`). You must copy the private key file into the directory you mount to Sourcebot (similar to the config file). |
| 50 | + |
| 51 | + You can generate a private key file for your app in the [app settings](https://docs.github.com/en/apps/creating-github-apps/writing-code-for-a-github-app/quickstart#navigate-to-your-app-settings). You must copy this private key file into the |
| 52 | + directory that you mount to Sourcebot |
| 53 | +  |
| 54 | + - `OPENAI_API_KEY`: Your OpenAI API key |
| 55 | + - `REVIEW_AGENT_AUTO_REVIEW_ENABLED` (default: `false`): If enabled, the review agent will automatically review any new or updated PR. If disabled, you must invoke it using the command defined by `REVIEW_AGENT_REVIEW_COMMAND` |
| 56 | + - `REVIEW_AGENT_REVIEW_COMMAND` (default: `review`): The command that invokes the review agent (ex. `/review`) when a user comments on the PR. Don't include the slash character in this value. |
| 57 | + |
| 58 | + You can find an example docker compose file below. |
| 59 | + - This docker compose file is placed in `~/sourcebot_review_agent_workspace`, and I'm mounting that directory to Sourcebot |
| 60 | + - The config and the app private key files are placed in this directory |
| 61 | + - The paths to these files are given to Sourcebot relative to `/data` since that's the directory in Sourcebot that I'm mounting to |
| 62 | + |
| 63 | + ```yaml |
| 64 | + services: |
| 65 | + sourcebot: |
| 66 | + image: ghcr.io/sourcebot-dev/sourcebot:latest |
| 67 | + pull_policy: always |
| 68 | + container_name: sourcebot |
| 69 | + ports: |
| 70 | + - "3000:3000" |
| 71 | + volumes: |
| 72 | + - "/Users/michael/sourcebot_review_agent_workspace:/data" |
| 73 | + environment: |
| 74 | + CONFIG_PATH: "/data/config.json" |
| 75 | + GITHUB_APP_ID: "my-github-app-id" |
| 76 | + GITHUB_APP_WEBHOOK_SECRET: "my-github-app-webhook-secret" |
| 77 | + GITHUB_APP_PRIVATE_KEY_PATH: "/data/review-agent-key.pem" |
| 78 | + OPENAI_API_KEY: "sk-proj-my-open-api-key" |
| 79 | + ``` |
| 80 | + </Step> |
| 81 | + <Step title="Verify configuration"> |
| 82 | + Navigate to the agents page by pressing `Agents` in the Sourcebot nav menu. If you've configured your environment variables correctly you'll see the following: |
| 83 | + |
| 84 | +  |
| 85 | + </Step> |
| 86 | +</Steps> |
| 87 | + |
| 88 | +# Using the agent |
| 89 | + |
| 90 | +The review agent will not automatically review your PRs by default. To enable this feature, set the `REVIEW_AGENT_AUTO_REVIEW_ENABLED` environment variable to true. |
| 91 | + |
| 92 | +You can invoke the review agent manually by commenting `/review` on the PR you'd like it to review. You can configure the command that triggers the agent by changing |
| 93 | +the `REVIEW_AGENT_REVIEW_COMMAND` environment variable. |
0 commit comments