mirror of
https://github.com/qodo-ai/pr-agent.git
synced 2025-07-03 04:10:49 +08:00
288 lines
18 KiB
Markdown
288 lines
18 KiB
Markdown
<div align="center">
|
|
|
|
<div align="center">
|
|
|
|
|
|
<picture>
|
|
<source media="(prefers-color-scheme: dark)" srcset="https://codium.ai/images/pr_agent/logo-dark.png" width="330">
|
|
<source media="(prefers-color-scheme: light)" srcset="https://codium.ai/images/pr_agent/logo-light.png" width="330">
|
|
<img alt="logo">
|
|
</picture>
|
|
<br/>
|
|
Making pull requests less painful with an AI agent
|
|
</div>
|
|
|
|
[](https://github.com/Codium-ai/pr-agent/blob/main/LICENSE)
|
|
[](https://discord.com/channels/1057273017547378788/1126104260430528613)
|
|
[](https://twitter.com/codiumai)
|
|
<a href="https://github.com/Codium-ai/pr-agent/commits/main">
|
|
<img alt="GitHub" src="https://img.shields.io/github/last-commit/Codium-ai/pr-agent/main?style=for-the-badge" height="20">
|
|
</a>
|
|
</div>
|
|
|
|
## Table of Contents
|
|
- [News and Updates](#news-and-updates)
|
|
- [Overview](#overview)
|
|
- [Example results](#example-results)
|
|
- [Features overview](#features-overview)
|
|
- [Try it now](#try-it-now)
|
|
- [Installation](#installation)
|
|
- [PR-Agent Pro 💎](#pr-agent-pro-)
|
|
- [How it works](#how-it-works)
|
|
- [Why use PR-Agent?](#why-use-pr-agent)
|
|
|
|
## News and Updates
|
|
### Jan 28, 2024
|
|
- 💎 Test - A new tool, [`/test component_name`](https://github.com/Codium-ai/pr-agent/blob/main/docs/TEST.md), was added to PR-Agent Pro. The tool will generate tests for a selected component, based on the PR code changes.
|
|
- 💎 Analyze - The [`/analyze`](https://github.com/Codium-ai/pr-agent/blob/main/docs/Analyze.md) tool was updated and simplified. It now presents a summary of the code components that were changed in the PR.
|
|
### Jan 21, 2024
|
|
- 💎 Custom suggestions - A new tool, `/custom_suggestions`, was added to PR-Agent Pro. The tool will propose only suggestions that follow specific guidelines defined by the user.
|
|
See [here](https://github.com/Codium-ai/pr-agent/blob/main/docs/CUSTOM_SUGGESTIONS.md) for more details.
|
|
|
|
### Jan 17, 2024
|
|
- 💎 Inline file summary - The `describe` tool has a new option `--pr_description.inline_file_summary`, which allows to add a summary of each file changes to the Diffview page. See [here](https://github.com/Codium-ai/pr-agent/blob/main/docs/DESCRIBE.md#inline-file-summary-)
|
|
- The `improve` tool can now present suggestions in a nice collapsible format, which significantly reduces the PR footprint. See [here](https://github.com/Codium-ai/pr-agent/blob/main/docs/IMPROVE.md#summarized-vs-commitable-code-suggestions) for more details.
|
|
- To accompany the improved interface of the `improve` tool, we change the [default automation settings](https://github.com/Codium-ai/pr-agent/blob/main/pr_agent/settings/configuration.toml#L116) of our GithupApp to:
|
|
```
|
|
pr_commands = [
|
|
"/describe --pr_description.add_original_user_description=true --pr_description.keep_original_user_title=true",
|
|
"/review --pr_reviewer.num_code_suggestions=0",
|
|
"/improve --pr_code_suggestions.summarize=true",
|
|
]
|
|
```
|
|
Meaning that by default, for each PR the `describe`, `review`, and `improve` tools will be triggered automatically, and the `improve` tool will present the suggestions in a single comment.
|
|
You can of course overwrite these defaults by adding a `.pr_agent.toml` file to your repo. See [here](https://github.com/Codium-ai/pr-agent/blob/main/Usage.md#working-with-github-app).
|
|
|
|
### Jan 10, 2024
|
|
[LanceDB](https://lancedb.com/) is now supported as a locally hosted VectorDB for the `similar_issue` tool. See [here](./docs/SIMILAR_ISSUE.md) for more details.
|
|
|
|
|
|
## Overview
|
|
<div style="text-align:left;">
|
|
|
|
CodiumAI PR-Agent is an open-source tool to help efficiently review and handle pull requests. It automatically analyzes the pull request and can provide several types of commands:
|
|
|
|
‣ **Auto Description ([`/describe`](./docs/DESCRIBE.md))**: Automatically generating PR description - title, type, summary, code walkthrough and labels.
|
|
\
|
|
‣ **Auto Review ([`/review`](./docs/REVIEW.md))**: Adjustable feedback about the PR main theme, type, relevant tests, security issues, score, and various suggestions for the PR content.
|
|
\
|
|
‣ **Question Answering ([`/ask ...`](./docs/ASK.md))**: Answering free-text questions about the PR.
|
|
\
|
|
‣ **Code Suggestions ([`/improve`](./docs/IMPROVE.md))**: Committable code suggestions for improving the PR.
|
|
\
|
|
‣ **Update Changelog ([`/update_changelog`](./docs/UPDATE_CHANGELOG.md))**: Automatically updating the CHANGELOG.md file with the PR changes.
|
|
\
|
|
‣ **Find Similar Issue ([`/similar_issue`](./docs/SIMILAR_ISSUE.md))**: Automatically retrieves and presents similar issues.
|
|
\
|
|
‣ **Add Documentation 💎 ([`/add_docs`](./docs/ADD_DOCUMENTATION.md))**: Automatically adds documentation to methods/functions/classes that changed in the PR.
|
|
\
|
|
‣ **Generate Custom Labels 💎 ([`/generate_labels`](./docs/GENERATE_CUSTOM_LABELS.md))**: Automatically suggests custom labels based on the PR code changes.
|
|
\
|
|
‣ **Analyze 💎 ([`/analyze`](./docs/Analyze.md))**: Automatically analyzes the PR, and presents changes walkthrough for each component.
|
|
\
|
|
‣ **Custom Suggestions 💎 ([`/custom_suggestions`](./docs/CUSTOM_SUGGESTIONS.md))**: Automatically generates custom suggestions for improving the PR code, based on specific guidelines defined by the user.
|
|
|
|
|
|
See the [Installation Guide](./INSTALL.md) for instructions on installing and running the tool on different git platforms.
|
|
|
|
See the [Usage Guide](./Usage.md) for running the PR-Agent commands via different interfaces, including _CLI_, _online usage_, or by _automatically triggering_ them when a new PR is opened.
|
|
|
|
See the [Tools Guide](./docs/TOOLS_GUIDE.md) for a detailed description of the different tools (tools are run via the commands).
|
|
|
|
|
|
## Example results
|
|
</div>
|
|
<h4><a href="https://github.com/Codium-ai/pr-agent/pull/530">/describe</a></h4>
|
|
<div align="center">
|
|
<p float="center">
|
|
<img src="https://www.codium.ai/images/pr_agent/describe_new_short_main.png" width="800">
|
|
</p>
|
|
</div>
|
|
<hr>
|
|
<h4><a href="https://github.com/Codium-ai/pr-agent/pull/472#discussion_r1435819374">/improve</a></h4>
|
|
|
|
<div align="center">
|
|
<p float="center">
|
|
<kbd>
|
|
<img src="https://www.codium.ai/images/pr_agent/improve_short_main.png" width="768">
|
|
</kbd>
|
|
</p>
|
|
|
|
</div>
|
|
<hr>
|
|
<h4><a href="https://github.com/Codium-ai/pr-agent/pull/530">/generate_labels</a></h4>
|
|
<div align="center">
|
|
<p float="center">
|
|
<kbd><img src="https://www.codium.ai/images/pr_agent/geneare_custom_labels_main_short.png" width="300"></kbd>
|
|
</p>
|
|
</div>
|
|
|
|
[//]: # (<h4><a href="https://github.com/Codium-ai/pr-agent/pull/78#issuecomment-1639739496">/reflect_and_review:</a></h4>)
|
|
|
|
[//]: # (<div align="center">)
|
|
|
|
[//]: # (<p float="center">)
|
|
|
|
[//]: # (<img src="https://www.codium.ai/images/reflect_and_review.gif" width="800">)
|
|
|
|
[//]: # (</p>)
|
|
|
|
[//]: # (</div>)
|
|
|
|
[//]: # (<h4><a href="https://github.com/Codium-ai/pr-agent/pull/229#issuecomment-1695020538">/ask:</a></h4>)
|
|
|
|
[//]: # (<div align="center">)
|
|
|
|
[//]: # (<p float="center">)
|
|
|
|
[//]: # (<img src="https://www.codium.ai/images/ask-2.gif" width="800">)
|
|
|
|
[//]: # (</p>)
|
|
|
|
[//]: # (</div>)
|
|
|
|
[//]: # (<h4><a href="https://github.com/Codium-ai/pr-agent/pull/229#issuecomment-1695024952">/improve:</a></h4>)
|
|
|
|
[//]: # (<div align="center">)
|
|
|
|
[//]: # (<p float="center">)
|
|
|
|
[//]: # (<img src="https://www.codium.ai/images/improve-2.gif" width="800">)
|
|
|
|
[//]: # (</p>)
|
|
|
|
[//]: # (</div>)
|
|
<div align="left">
|
|
|
|
|
|
</div>
|
|
<hr>
|
|
|
|
## Features overview
|
|
`PR-Agent` offers extensive pull request functionalities across various git providers:
|
|
| | | GitHub | Gitlab | Bitbucket |
|
|
|-------|---------------------------------------------|:------:|:------:|:---------:|
|
|
| TOOLS | Review | :white_check_mark: | :white_check_mark: | :white_check_mark: |
|
|
| | ⮑ Incremental | :white_check_mark: | | |
|
|
| | ⮑ [SOC2 Compliance](https://github.com/Codium-ai/pr-agent/blob/main/docs/REVIEW.md#soc2-ticket-compliance-) 💎 | :white_check_mark: | :white_check_mark: | :white_check_mark: |
|
|
| | Ask | :white_check_mark: | :white_check_mark: | :white_check_mark: |
|
|
| | Describe | :white_check_mark: | :white_check_mark: | :white_check_mark: |
|
|
| | ⮑ [Inline file summary](https://github.com/Codium-ai/pr-agent/blob/main/docs/DESCRIBE.md#inline-file-summary-) 💎 | :white_check_mark: | :white_check_mark: | :white_check_mark: |
|
|
| | Improve | :white_check_mark: | :white_check_mark: | :white_check_mark: |
|
|
| | ⮑ Extended | :white_check_mark: | :white_check_mark: | :white_check_mark: |
|
|
| | [Custom Suggestions](https://github.com/Codium-ai/pr-agent/blob/main/docs/CUSTOM_SUGGESTIONS.md) 💎 | :white_check_mark: | :white_check_mark: | :white_check_mark: |
|
|
| | [Test](https://github.com/Codium-ai/pr-agent/blob/main/docs/Test.md) 💎 | :white_check_mark: | :white_check_mark: | :white_check_mark: |
|
|
| | Reflect and Review | :white_check_mark: | :white_check_mark: | :white_check_mark: |
|
|
| | Update CHANGELOG.md | :white_check_mark: | :white_check_mark: | :white_check_mark: |
|
|
| | Find Similar Issue | :white_check_mark: | | |
|
|
| | [Add PR Documentation](https://github.com/Codium-ai/pr-agent/blob/main/docs/ADD_DOCUMENTATION.md) 💎 | :white_check_mark: | :white_check_mark: | :white_check_mark: |
|
|
| | [Generate Custom Labels](https://github.com/Codium-ai/pr-agent/blob/main/docs/DESCRIBE.md#handle-custom-labels-from-the-repos-labels-page-gem) 💎 | :white_check_mark: | :white_check_mark: | |
|
|
| | [Analyze PR Components](https://github.com/Codium-ai/pr-agent/blob/main/docs/Analyze.md) 💎 | :white_check_mark: | :white_check_mark: | :white_check_mark: |
|
|
| | | | | |
|
|
| USAGE | CLI | :white_check_mark: | :white_check_mark: | :white_check_mark: |
|
|
| | App / webhook | :white_check_mark: | :white_check_mark: | |
|
|
| | Tagging bot | :white_check_mark: | | |
|
|
| | Actions | :white_check_mark: | | |
|
|
| | | | | |
|
|
| CORE | PR compression | :white_check_mark: | :white_check_mark: | :white_check_mark: |
|
|
| | Repo language prioritization | :white_check_mark: | :white_check_mark: | :white_check_mark: |
|
|
| | Adaptive and token-aware<br />file patch fitting | :white_check_mark: | :white_check_mark: | :white_check_mark: |
|
|
| | Multiple models support | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: |
|
|
| | Incremental PR review | :white_check_mark: | | |
|
|
| | [Static code analysis](https://github.com/Codium-ai/pr-agent/blob/main/docs/Analyze.md) 💎 | :white_check_mark: | :white_check_mark: | :white_check_mark: |
|
|
| | [Global configuration](https://github.com/Codium-ai/pr-agent/blob/main/Usage.md#global-configuration-file-) 💎 | :white_check_mark: | :white_check_mark: | :white_check_mark: |
|
|
|
|
|
|
- 💎 means this feature is available only in [PR-Agent Pro](https://www.codium.ai/pricing/)
|
|
- Support for additional git providers is described in [here](./docs/Full_environments.md)
|
|
|
|
## Try it now
|
|
|
|
Try the GPT-4 powered PR-Agent instantly on _your public GitHub repository_. Just mention `@CodiumAI-Agent` and add the desired command in any PR comment. The agent will generate a response based on your command.
|
|
For example, add a comment to any pull request with the following text:
|
|
```
|
|
@CodiumAI-Agent /review
|
|
```
|
|
and the agent will respond with a review of your PR
|
|
|
|
|
|
|
|
|
|
To set up your own PR-Agent, see the [Installation](#installation) section below.
|
|
Note that when you set your own PR-Agent or use CodiumAI hosted PR-Agent, there is no need to mention `@CodiumAI-Agent ...`. Instead, directly start with the command, e.g., `/ask ...`.
|
|
|
|
---
|
|
|
|
## Installation
|
|
To use your own version of PR-Agent, you first need to acquire two tokens:
|
|
|
|
1. An OpenAI key from [here](https://platform.openai.com/), with access to GPT-4.
|
|
2. A GitHub personal access token (classic) with the repo scope.
|
|
|
|
There are several ways to use PR-Agent:
|
|
|
|
- [Method 1: Use Docker image (no installation required)](INSTALL.md#method-1-use-docker-image-no-installation-required)
|
|
- [Method 2: Run from source](INSTALL.md#method-2-run-from-source)
|
|
- [Method 3: Run as a GitHub Action](INSTALL.md#method-3-run-as-a-github-action)
|
|
- [Method 4: Run as a polling server](INSTALL.md#method-4-run-as-a-polling-server)
|
|
- Request reviews by tagging your GitHub user on a PR
|
|
- [Method 5: Run as a GitHub App](INSTALL.md#method-5-run-as-a-github-app)
|
|
- Allowing you to automate the review process on your private or public repositories
|
|
- [Method 6: Deploy as a Lambda Function](INSTALL.md#method-6---deploy-as-a-lambda-function)
|
|
- [Method 7: AWS CodeCommit](INSTALL.md#method-7---aws-codecommit-setup)
|
|
- [Method 8: Run a GitLab webhook server](INSTALL.md#method-8---run-a-gitlab-webhook-server)
|
|
- [Method 9: Run as a Bitbucket Pipeline](INSTALL.md#method-9-run-as-a-bitbucket-pipeline)
|
|
|
|
## PR-Agent Pro 💎
|
|
[PR-Agent Pro](https://www.codium.ai/pricing/) is a hosted version of PR-Agent, provided by CodiumAI. It is available for a monthly fee, and provides the following benefits:
|
|
1. **Fully managed** - We take care of everything for you - hosting, models, regular updates, and more. Installation is as simple as signing up and adding the PR-Agent app to your GitHub\BitBucket repo.
|
|
2. **Improved privacy** - No data will be stored or used to train models. PR-Agent Pro will employ zero data retention, and will use an OpenAI account with zero data retention.
|
|
3. **Improved support** - PR-Agent Pro users will receive priority support, and will be able to request new features and capabilities.
|
|
4. **Extra features** -In addition to the benefits listed above, PR-Agent Pro will emphasize more customization, and the usage of static code analysis, in addition to LLM logic, to improve results. It has the following additional features:
|
|
- [**SOC2 compliance check**](https://github.com/Codium-ai/pr-agent/blob/main/docs/REVIEW.md#soc2-ticket-compliance-)
|
|
- [**PR documentation**](https://github.com/Codium-ai/pr-agent/blob/main/docs/ADD_DOCUMENTATION.md)
|
|
- [**Custom labels**](https://github.com/Codium-ai/pr-agent/blob/main/docs/DESCRIBE.md#handle-custom-labels-from-the-repos-labels-page-gem)
|
|
- [**Global configuration**](https://github.com/Codium-ai/pr-agent/blob/main/Usage.md#global-configuration-file-)
|
|
- [**Analyze PR components**](https://github.com/Codium-ai/pr-agent/blob/main/docs/Analyze.md)
|
|
- **Custom Code Suggestions** [WIP]
|
|
- **Chat on Specific Code Lines** [WIP]
|
|
|
|
|
|
## How it works
|
|
|
|
The following diagram illustrates PR-Agent tools and their flow:
|
|
|
|
|
|
|
|
Check out the [PR Compression strategy](./PR_COMPRESSION.md) page for more details on how we convert a code diff to a manageable LLM prompt
|
|
|
|
## Why use PR-Agent?
|
|
|
|
A reasonable question that can be asked is: `"Why use PR-Agent? What makes it stand out from existing tools?"`
|
|
|
|
Here are some advantages of PR-Agent:
|
|
|
|
- We emphasize **real-life practical usage**. Each tool (review, improve, ask, ...) has a single GPT-4 call, no more. We feel that this is critical for realistic team usage - obtaining an answer quickly (~30 seconds) and affordably.
|
|
- Our [PR Compression strategy](./PR_COMPRESSION.md) is a core ability that enables to effectively tackle both short and long PRs.
|
|
- Our JSON prompting strategy enables to have **modular, customizable tools**. For example, the '/review' tool categories can be controlled via the [configuration](pr_agent/settings/configuration.toml) file. Adding additional categories is easy and accessible.
|
|
- We support **multiple git providers** (GitHub, Gitlab, Bitbucket), **multiple ways** to use the tool (CLI, GitHub Action, GitHub App, Docker, ...), and **multiple models** (GPT-4, GPT-3.5, Anthropic, Cohere, Llama2).
|
|
|
|
|
|
## Data privacy
|
|
|
|
If you host PR-Agent with your OpenAI API key, it is between you and OpenAI. You can read their API data privacy policy here:
|
|
https://openai.com/enterprise-privacy
|
|
|
|
When using PR-Agent Pro 💎, hosted by CodiumAI, we will not store any of your data, nor will we use it for training.
|
|
You will also benefit from an OpenAI account with zero data retention.
|
|
|
|
## Links
|
|
|
|
[](https://discord.gg/kG35uSHDBc)
|
|
|
|
- Discord community: https://discord.gg/kG35uSHDBc
|
|
- CodiumAI site: https://codium.ai
|
|
- Blog: https://www.codium.ai/blog/
|
|
- Troubleshooting: https://www.codium.ai/blog/technical-faq-and-troubleshooting/
|
|
- Support: support@codium.ai
|