mirror of
https://github.com/qodo-ai/pr-agent.git
synced 2025-07-08 14:50:40 +08:00
Compare commits
2 Commits
v0.12
...
ok/azure_d
| Author | SHA1 | Date | |
|---|---|---|---|
| c8b6d34189 | |||
| 95a8a28071 |
6
.github/workflows/pr-agent-review.yaml
vendored
6
.github/workflows/pr-agent-review.yaml
vendored
@ -27,9 +27,7 @@ jobs:
|
|||||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||||
PINECONE.API_KEY: ${{ secrets.PINECONE_API_KEY }}
|
PINECONE.API_KEY: ${{ secrets.PINECONE_API_KEY }}
|
||||||
PINECONE.ENVIRONMENT: ${{ secrets.PINECONE_ENVIRONMENT }}
|
PINECONE.ENVIRONMENT: ${{ secrets.PINECONE_ENVIRONMENT }}
|
||||||
GITHUB_ACTION_CONFIG.AUTO_DESCRIBE: true
|
GITHUB_ACTION.AUTO_REVIEW: true
|
||||||
GITHUB_ACTION_CONFIG.AUTO_REVIEW: true
|
GITHUB_ACTION.AUTO_IMPROVE: true
|
||||||
GITHUB_ACTION_CONFIG.AUTO_IMPROVE: true
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
1
.gitignore
vendored
1
.gitignore
vendored
@ -6,4 +6,3 @@ dist/
|
|||||||
*.egg-info/
|
*.egg-info/
|
||||||
build/
|
build/
|
||||||
review.md
|
review.md
|
||||||
.DS_Store
|
|
||||||
|
|||||||
18
INSTALL.md
18
INSTALL.md
@ -3,8 +3,8 @@
|
|||||||
|
|
||||||
To get started with PR-Agent quickly, you first need to acquire two tokens:
|
To get started with PR-Agent quickly, you first need to acquire two tokens:
|
||||||
|
|
||||||
1. An OpenAI key from [here](https://platform.openai.com/api-keys), with access to GPT-4.
|
1. An OpenAI key from [here](https://platform.openai.com/), with access to GPT-4.
|
||||||
2. A GitHub\GitLab\BitBucket personal access token (classic), with the repo scope. [GitHub from [here](https://github.com/settings/tokens)]
|
2. A GitHub\GitLab\BitBucket personal access token (classic) with the repo scope.
|
||||||
|
|
||||||
There are several ways to use PR-Agent:
|
There are several ways to use PR-Agent:
|
||||||
|
|
||||||
@ -79,14 +79,12 @@ codiumai/pr-agent@v0.9
|
|||||||
git clone https://github.com/Codium-ai/pr-agent.git
|
git clone https://github.com/Codium-ai/pr-agent.git
|
||||||
```
|
```
|
||||||
|
|
||||||
2. Navigate to the `/pr-agent` folder and install the requirements in your favorite virtual environment:
|
2. Install the requirements in your favorite virtual environment:
|
||||||
|
|
||||||
```
|
```
|
||||||
pip install -e .
|
pip install -r requirements.txt
|
||||||
```
|
```
|
||||||
|
|
||||||
*Note: If you get an error related to Rust in the dependency installation then make sure Rust is installed and in your `PATH`, instructions: https://rustup.rs*
|
|
||||||
|
|
||||||
3. Copy the secrets template file and fill in your OpenAI key and your GitHub user token:
|
3. Copy the secrets template file and fill in your OpenAI key and your GitHub user token:
|
||||||
|
|
||||||
```
|
```
|
||||||
@ -95,9 +93,10 @@ chmod 600 pr_agent/settings/.secrets.toml
|
|||||||
# Edit .secrets.toml file
|
# Edit .secrets.toml file
|
||||||
```
|
```
|
||||||
|
|
||||||
4. Run the cli.py script:
|
4. Add the pr_agent folder to your PYTHONPATH, then run the cli.py script:
|
||||||
|
|
||||||
```
|
```
|
||||||
|
export PYTHONPATH=[$PYTHONPATH:]<PATH to pr_agent folder>
|
||||||
python3 -m pr_agent.cli --pr_url <pr_url> review
|
python3 -m pr_agent.cli --pr_url <pr_url> review
|
||||||
python3 -m pr_agent.cli --pr_url <pr_url> ask <your question>
|
python3 -m pr_agent.cli --pr_url <pr_url> ask <your question>
|
||||||
python3 -m pr_agent.cli --pr_url <pr_url> describe
|
python3 -m pr_agent.cli --pr_url <pr_url> describe
|
||||||
@ -108,11 +107,6 @@ python3 -m pr_agent.cli --issue_url <issue_url> similar_issue
|
|||||||
...
|
...
|
||||||
```
|
```
|
||||||
|
|
||||||
[Optional] Add the pr_agent folder to your PYTHONPATH
|
|
||||||
```
|
|
||||||
export PYTHONPATH=$PYTHONPATH:<PATH to pr_agent folder>
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
### Run as a GitHub Action
|
### Run as a GitHub Action
|
||||||
|
|||||||
121
README.md
121
README.md
@ -19,82 +19,10 @@ Making pull requests less painful with an AI agent
|
|||||||
<img alt="GitHub" src="https://img.shields.io/github/last-commit/Codium-ai/pr-agent/main?style=for-the-badge" height="20">
|
<img alt="GitHub" src="https://img.shields.io/github/last-commit/Codium-ai/pr-agent/main?style=for-the-badge" height="20">
|
||||||
</a>
|
</a>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
## Table of Contents
|
|
||||||
- [News and Updates](#news-and-updates)
|
|
||||||
- [Overview](#overview)
|
|
||||||
- [Example results](#example-results)
|
|
||||||
- [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;">
|
<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:
|
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:
|
||||||
|
|
||||||
| | | 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: |
|
|
||||||
| | 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: | | |
|
|
||||||
| | Improve | :white_check_mark: | :white_check_mark: | :white_check_mark: |
|
|
||||||
| | ⮑ Extended | :white_check_mark: | :white_check_mark: | :white_check_mark: |
|
|
||||||
| | Ask | :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: |
|
|
||||||
| | [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](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: | :white_check_mark: |
|
|
||||||
| | Tagging bot | :white_check_mark: | | |
|
|
||||||
| | Actions | :white_check_mark: | | :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: |
|
|
||||||
| | [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)
|
|
||||||
___
|
|
||||||
|
|
||||||
‣ **Auto Description ([`/describe`](./docs/DESCRIBE.md))**: Automatically generating PR description - title, type, summary, code walkthrough and labels.
|
‣ **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.
|
‣ **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.
|
||||||
@ -112,10 +40,7 @@ ___
|
|||||||
‣ **Generate Custom Labels 💎 ([`/generate_labels`](./docs/GENERATE_CUSTOM_LABELS.md))**: Automatically suggests custom labels based on the PR code changes.
|
‣ **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.
|
‣ **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.
|
|
||||||
\
|
|
||||||
‣ **Generate Tests 💎 ([`/test component_name`](./docs/TEST.md))**: Automatically generates unit tests for a selected component, based on the PR code changes.
|
|
||||||
|
|
||||||
See the [Installation Guide](./INSTALL.md) for instructions on installing and running the tool on different git platforms.
|
See the [Installation Guide](./INSTALL.md) for instructions on installing and running the tool on different git platforms.
|
||||||
|
|
||||||
@ -123,13 +48,21 @@ See the [Usage Guide](./Usage.md) for running the PR-Agent commands via differen
|
|||||||
|
|
||||||
See the [Tools Guide](./docs/TOOLS_GUIDE.md) for a detailed description of the different tools (tools are run via the commands).
|
See the [Tools Guide](./docs/TOOLS_GUIDE.md) for a detailed description of the different tools (tools are run via the commands).
|
||||||
|
|
||||||
|
## Table of Contents
|
||||||
|
- [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)
|
||||||
|
|
||||||
## Example results
|
## Example results
|
||||||
</div>
|
</div>
|
||||||
<h4><a href="https://github.com/Codium-ai/pr-agent/pull/530">/describe</a></h4>
|
<h4><a href="https://github.com/Codium-ai/pr-agent/pull/530">/describe</a></h4>
|
||||||
<div align="center">
|
<div align="center">
|
||||||
<p float="center">
|
<p float="center">
|
||||||
<img src="https://www.codium.ai/images/pr_agent/describe_new_short_main.png" width="800">
|
<img src="https://www.codium.ai/images/pr_agent/describe_short_main.png" width="800">
|
||||||
</p>
|
</p>
|
||||||
</div>
|
</div>
|
||||||
<hr>
|
<hr>
|
||||||
@ -192,6 +125,40 @@ See the [Tools Guide](./docs/TOOLS_GUIDE.md) for a detailed description of the d
|
|||||||
</div>
|
</div>
|
||||||
<hr>
|
<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: |
|
||||||
|
| | Improve | :white_check_mark: | :white_check_mark: | :white_check_mark: |
|
||||||
|
| | ⮑ Extended | :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_enviroments.md)
|
||||||
|
|
||||||
## Try it now
|
## Try it now
|
||||||
|
|
||||||
|
|||||||
35
Usage.md
35
Usage.md
@ -142,20 +142,28 @@ num_code_suggestions=1
|
|||||||
Then you will overwrite the default number of code suggestions to 1.
|
Then you will overwrite the default number of code suggestions to 1.
|
||||||
|
|
||||||
#### GitHub app automatic tools
|
#### GitHub app automatic tools
|
||||||
The [github_app](pr_agent/settings/configuration.toml#L108) section defines GitHub app specific configurations.
|
The [github_app](pr_agent/settings/configuration.toml#L76) section defines GitHub app-specific configurations.
|
||||||
|
In this section, you can define configurations to control the conditions for which tools will **run automatically**.
|
||||||
|
|
||||||
##### GitHub app automatic tools for PR actions
|
##### GitHub app automatic tools for PR actions
|
||||||
The configuration parameter `pr_commands` defines the list of tools that will be **run automatically** when a new PR is opened.
|
The GitHub app can respond to the following actions on a PR:
|
||||||
|
1. `opened` - Opening a new PR
|
||||||
|
2. `reopened` - Reopening a closed PR
|
||||||
|
3. `ready_for_review` - Moving a PR from Draft to Open
|
||||||
|
4. `review_requested` - Specifically requesting review (in the PR reviewers list) from the `github-actions[bot]` user
|
||||||
|
|
||||||
|
The configuration parameter `handle_pr_actions` defines the list of actions for which the GitHub app will trigger the PR-Agent.
|
||||||
|
The configuration parameter `pr_commands` defines the list of tools that will be **run automatically** when one of the above actions happens (e.g., a new PR is opened):
|
||||||
```
|
```
|
||||||
[github_app]
|
[github_app]
|
||||||
|
handle_pr_actions = ['opened', 'reopened', 'ready_for_review', 'review_requested']
|
||||||
pr_commands = [
|
pr_commands = [
|
||||||
"/describe --pr_description.add_original_user_description=true --pr_description.keep_original_user_title=true",
|
"/describe --pr_description.add_original_user_description=true --pr_description.keep_original_user_title=true",
|
||||||
"/review --pr_reviewer.num_code_suggestions=0",
|
"/review",
|
||||||
"/improve",
|
|
||||||
]
|
]
|
||||||
```
|
```
|
||||||
This means that when a new PR is opened/reopened or marked as ready for review, PR-Agent will run the `describe`, `review` and `improve` tools.
|
This means that when a new PR is opened/reopened or marked as ready for review, PR-Agent will run the `describe` and `review` tools.
|
||||||
For the `describe` tool, for example, the `add_original_user_description` and `keep_original_user_title` parameters will be set to true.
|
For the `describe` tool, the `add_original_user_description` and `keep_original_user_title` parameters will be set to true.
|
||||||
|
|
||||||
You can override the default tool parameters by uploading a local configuration file called `.pr_agent.toml` to the root of your repo.
|
You can override the default tool parameters by uploading a local configuration file called `.pr_agent.toml` to the root of your repo.
|
||||||
For example, if your local `.pr_agent.toml` file contains:
|
For example, if your local `.pr_agent.toml` file contains:
|
||||||
@ -172,7 +180,7 @@ To cancel the automatic run of all the tools, set:
|
|||||||
handle_pr_actions = []
|
handle_pr_actions = []
|
||||||
```
|
```
|
||||||
|
|
||||||
##### GitHub app automatic tools for push actions (commits to an open PR)
|
##### GitHub app automatic tools for new code (PR push)
|
||||||
In addition to running automatic tools when a PR is opened, the GitHub app can also respond to new code that is pushed to an open PR.
|
In addition to running automatic tools when a PR is opened, the GitHub app can also respond to new code that is pushed to an open PR.
|
||||||
|
|
||||||
The configuration toggle `handle_push_trigger` can be used to enable this feature.
|
The configuration toggle `handle_push_trigger` can be used to enable this feature.
|
||||||
@ -209,19 +217,18 @@ user="""
|
|||||||
Note that the new prompt will need to generate an output compatible with the relevant [post-process function](./pr_agent/tools/pr_description.py#L137).
|
Note that the new prompt will need to generate an output compatible with the relevant [post-process function](./pr_agent/tools/pr_description.py#L137).
|
||||||
|
|
||||||
### Working with GitHub Action
|
### Working with GitHub Action
|
||||||
`GitHub Action` is a different way to trigger PR-Agent tools, and uses a different configuration mechanism than `GitHub App`.
|
You can configure settings in GitHub action by adding environment variables under the env section in `.github/workflows/pr_agent.yml` file.
|
||||||
You can configure settings for `GitHub Action` by adding environment variables under the env section in `.github/workflows/pr_agent.yml` file.
|
|
||||||
Specifically, start by setting the following environment variables:
|
Specifically, start by setting the following environment variables:
|
||||||
```yaml
|
```yaml
|
||||||
env:
|
env:
|
||||||
OPENAI_KEY: ${{ secrets.OPENAI_KEY }} # Make sure to add your OpenAI key to your repo secrets
|
OPENAI_KEY: ${{ secrets.OPENAI_KEY }} # Make sure to add your OpenAI key to your repo secrets
|
||||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # Make sure to add your GitHub token to your repo secrets
|
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # Make sure to add your GitHub token to your repo secrets
|
||||||
github_action_config.auto_review: "true" # enable\disable auto review
|
github_action.auto_review: "true" # enable\disable auto review
|
||||||
github_action_config.auto_describe: "true" # enable\disable auto describe
|
github_action.auto_describe: "true" # enable\disable auto describe
|
||||||
github_action_config.auto_improve: "true" # enable\disable auto improve
|
github_action.auto_improve: "false" # enable\disable auto improve
|
||||||
```
|
```
|
||||||
`github_action_config.auto_review`, `github_action_config.auto_describe` and `github_action_config.auto_improve` are used to enable/disable automatic tools that run when a new PR is opened.
|
`github_action.auto_review`, `github_action.auto_describe` and `github_action.auto_improve` are used to enable/disable automatic tools that run when a new PR is opened.
|
||||||
If not set, the default configuration is for all three tools to run automatically when a new PR is opened.
|
If not set, the default option is that only the `review` tool will run automatically when a new PR is opened.
|
||||||
|
|
||||||
Note that you can give additional config parameters by adding environment variables to `.github/workflows/pr_agent.yml`, or by using a `.pr_agent.toml` file in the root of your repo, similar to the GitHub App usage.
|
Note that you can give additional config parameters by adding environment variables to `.github/workflows/pr_agent.yml`, or by using a `.pr_agent.toml` file in the root of your repo, similar to the GitHub App usage.
|
||||||
|
|
||||||
|
|||||||
10
docs/ASK.md
10
docs/ASK.md
@ -1,15 +1,11 @@
|
|||||||
# ASK Tool
|
# ASK Tool
|
||||||
|
|
||||||
The `ask` tool answers questions about the PR, based on the PR code changes. Make sure to be specific and clear in your questions.
|
The `ask` tool answers questions about the PR, based on the PR code changes.
|
||||||
It can be invoked manually by commenting on any PR:
|
It can be invoked manually by commenting on any PR:
|
||||||
```
|
```
|
||||||
/ask "..."
|
/ask "..."
|
||||||
```
|
```
|
||||||
For example:
|
For example:
|
||||||
___
|
|
||||||
<kbd><img src=https://codium.ai/images/pr_agent/ask_comment.png width="768"></kbd>
|
|
||||||
___
|
|
||||||
<kbd><img src=https://codium.ai/images/pr_agent/ask.png width="768"></kbd>
|
|
||||||
___
|
|
||||||
|
|
||||||
Note that the tool does not have "memory" of previous questions, and answers each question independently.
|
<kbd><img src=https://codium.ai/images/pr_agent/ask_comment.png width="768"></kbd>
|
||||||
|
<kbd><img src=https://codium.ai/images/pr_agent/ask.png width="768"></kbd>
|
||||||
@ -1,65 +0,0 @@
|
|||||||
# Custom Suggestions Tool 💎
|
|
||||||
|
|
||||||
## Table of Contents
|
|
||||||
- [Overview](#overview)
|
|
||||||
- [Example usage](#example-usage)
|
|
||||||
- [Configuration options](#configuration-options)
|
|
||||||
|
|
||||||
|
|
||||||
## Overview
|
|
||||||
The `custom_suggestions` tool scans the PR code changes, and automatically generates custom suggestions for improving the PR code.
|
|
||||||
It shares similarities with the `improve` tool, but with one main difference: the `custom_suggestions` tool will only propose suggestions that follow specific guidelines defined by the prompt in: `pr_custom_suggestions.prompt` configuration.
|
|
||||||
|
|
||||||
The tool can be triggered [automatically](https://github.com/Codium-ai/pr-agent/blob/main/Usage.md#github-app-automatic-tools) every time a new PR is opened, or can be invoked manually by commenting on a PR.
|
|
||||||
|
|
||||||
When commenting, use the following template:
|
|
||||||
|
|
||||||
```
|
|
||||||
/custom_suggestions --pr_custom_suggestions.prompt="The suggestions should focus only on the following:\n-...\n-...\n-..."
|
|
||||||
```
|
|
||||||
|
|
||||||
With a [configuration file](https://github.com/Codium-ai/pr-agent/blob/main/Usage.md#working-with-github-app), use the following template:
|
|
||||||
|
|
||||||
```
|
|
||||||
[pr_custom_suggestions]
|
|
||||||
prompt="""\
|
|
||||||
The suggestions should focus only on the following:
|
|
||||||
-...
|
|
||||||
-...
|
|
||||||
-...
|
|
||||||
"""
|
|
||||||
```
|
|
||||||
Using a configuration file is recommended, since it allows to use multi-line instructions.
|
|
||||||
|
|
||||||
Don't forget - with this tool, you are the prompter. Be specific, clear, and concise in the instructions. Specify relevant aspects that you want the model to focus on. \
|
|
||||||
You might benefit from several trial-and-error iterations, until you get the correct prompt for your use case.
|
|
||||||
|
|
||||||
## Example usage
|
|
||||||
|
|
||||||
Here is an example of a possible prompt:
|
|
||||||
```
|
|
||||||
[pr_custom_suggestions]
|
|
||||||
prompt="""\
|
|
||||||
The suggestions should focus only on the following:
|
|
||||||
- look for edge cases when implementing a new function
|
|
||||||
- make sure every variable has a meaningful name
|
|
||||||
- make sure the code is efficient
|
|
||||||
"""
|
|
||||||
```
|
|
||||||
|
|
||||||
The instructions above are just an example. We want to emphasize that the prompt should be specific and clear, and be tailored to the needs of your project.
|
|
||||||
|
|
||||||
Results obtained with the prompt above:
|
|
||||||
___
|
|
||||||
<kbd><img src=https://codium.ai/images/pr_agent/custom_suggestions_prompt.png width="512"></kbd>
|
|
||||||
___
|
|
||||||
<kbd><img src=https://codium.ai/images/pr_agent/custom_suggestions_result.png width="768"></kbd>
|
|
||||||
___
|
|
||||||
|
|
||||||
## Configuration options
|
|
||||||
|
|
||||||
`prompt`: the prompt for the tool. It should be a multi-line string.
|
|
||||||
|
|
||||||
`num_code_suggestions`: number of code suggestions provided by the 'custom_suggestions' tool. Default is 4.
|
|
||||||
|
|
||||||
`enable_help_text`: if set to true, the tool will display a help text in the comment. Default is true.
|
|
||||||
@ -2,7 +2,6 @@
|
|||||||
## Table of Contents
|
## Table of Contents
|
||||||
- [Overview](#overview)
|
- [Overview](#overview)
|
||||||
- [Configuration options](#configuration-options)
|
- [Configuration options](#configuration-options)
|
||||||
- [Inline file summary 💎](#inline-file-summary-)
|
|
||||||
- [Handle custom labels from the Repo's labels page :gem:](#handle-custom-labels-from-the-repos-labels-page-gem)
|
- [Handle custom labels from the Repo's labels page :gem:](#handle-custom-labels-from-the-repos-labels-page-gem)
|
||||||
- [Markers template](#markers-template)
|
- [Markers template](#markers-template)
|
||||||
- [Usage Tips](#usage-tips)
|
- [Usage Tips](#usage-tips)
|
||||||
@ -20,7 +19,7 @@ For example:
|
|||||||
___
|
___
|
||||||
<kbd><img src=https://codium.ai/images/pr_agent/describe_comment.png width="768"></kbd>
|
<kbd><img src=https://codium.ai/images/pr_agent/describe_comment.png width="768"></kbd>
|
||||||
___
|
___
|
||||||
<kbd><img src=https://codium.ai/images/pr_agent/describe_new.png width="768"></kbd>
|
<kbd><img src=https://codium.ai/images/pr_agent/describe.png width="768"></kbd>
|
||||||
___
|
___
|
||||||
|
|
||||||
### Configuration options
|
### Configuration options
|
||||||
@ -49,19 +48,6 @@ To edit [configurations](./../pr_agent/settings/configuration.toml#L46) related
|
|||||||
- `enable_semantic_files_types`: if set to true, "Changes walkthrough" section will be generated. Default is true.
|
- `enable_semantic_files_types`: if set to true, "Changes walkthrough" section will be generated. Default is true.
|
||||||
- `collapsible_file_list`: if set to true, the file list in the "Changes walkthrough" section will be collapsible. If set to "adaptive", the file list will be collapsible only if there are more than 8 files. Default is "adaptive".
|
- `collapsible_file_list`: if set to true, the file list in the "Changes walkthrough" section will be collapsible. If set to "adaptive", the file list will be collapsible only if there are more than 8 files. Default is "adaptive".
|
||||||
|
|
||||||
### Inline file summary 💎
|
|
||||||
> This feature is available only in PR-Agent Pro
|
|
||||||
|
|
||||||
This will enable you to quickly understand the changes in each file, while reviewing the code changes (diff view).
|
|
||||||
To enable inline file summary, set `pr_description.inline_file_summary` in the configuration file, possible values are:
|
|
||||||
- `'table'`: File changes walkthrough table will be displayed on the top of the "Files changed" tab, in addition to the "Conversation" tab.
|
|
||||||
<kbd><img src=https://codium.ai/images/pr_agent/diffview-table.png width="1024"></kbd>
|
|
||||||
- `true`: A collapsable file comment with changes title and a changes summary for each file in the PR.
|
|
||||||
<kbd><img src=https://codium.ai/images/pr_agent/diffview_changes.png width="1024"></kbd>
|
|
||||||
- `false` (`default`): File changes walkthrough will be added only to the "Conversation" tab.
|
|
||||||
|
|
||||||
*Note that this feature is currently available only for GitHub.
|
|
||||||
|
|
||||||
|
|
||||||
### Handle custom labels from the Repo's labels page :gem:
|
### Handle custom labels from the Repo's labels page :gem:
|
||||||
> This feature is available only in PR-Agent Pro
|
> This feature is available only in PR-Agent Pro
|
||||||
@ -144,7 +130,7 @@ The default labels of the describe tool are quite generic, since they are meant
|
|||||||
|
|
||||||
If you specify [custom labels](#handle-custom-labels-from-the-repos-labels-page-gem) in the repo's labels page, you can get tailored labels for your use cases.
|
If you specify [custom labels](#handle-custom-labels-from-the-repos-labels-page-gem) in the repo's labels page, you can get tailored labels for your use cases.
|
||||||
Examples for custom labels:
|
Examples for custom labels:
|
||||||
- `Main topic:performance` - pr_agent:The main topic of this PR is performance
|
- `Main topic:performence` - pr_agent:The main topic of this PR is performance
|
||||||
- `New endpoint` - pr_agent:A new endpoint was added in this PR
|
- `New endpoint` - pr_agent:A new endpoint was added in this PR
|
||||||
- `SQL query` - pr_agent:A new SQL query was added in this PR
|
- `SQL query` - pr_agent:A new SQL query was added in this PR
|
||||||
- `Dockerfile changes` - pr_agent:The PR contains changes in the Dockerfile
|
- `Dockerfile changes` - pr_agent:The PR contains changes in the Dockerfile
|
||||||
@ -152,4 +138,4 @@ Examples for custom labels:
|
|||||||
|
|
||||||
The list above is eclectic, and aims to give an idea of different possibilities. Define custom labels that are relevant for your repo and use cases.
|
The list above is eclectic, and aims to give an idea of different possibilities. Define custom labels that are relevant for your repo and use cases.
|
||||||
Note that Labels are not mutually exclusive, so you can add multiple label categories.
|
Note that Labels are not mutually exclusive, so you can add multiple label categories.
|
||||||
<br>Make sure to provide proper title, and a detailed and well-phrased description for each label, so the tool will know when to suggest it.
|
<br>Make sure to provide proper title, and detailed and well-phrased description for each label, so the tool will know when to suggest it.
|
||||||
@ -10,28 +10,21 @@
|
|||||||
- [A note on code suggestions quality](#a-note-on-code-suggestions-quality)
|
- [A note on code suggestions quality](#a-note-on-code-suggestions-quality)
|
||||||
|
|
||||||
## Overview
|
## Overview
|
||||||
The `improve` tool scans the PR code changes, and automatically generates suggestions for improving the PR code.
|
The `improve` tool scans the PR code changes, and automatically generates committable suggestions for improving the PR code.
|
||||||
The tool can be triggered automatically every time a new PR is [opened](https://github.com/Codium-ai/pr-agent/blob/main/Usage.md#github-app-automatic-tools), or it can be invoked manually by commenting on any PR:
|
The tool can be triggered automatically every time a new PR is [opened](https://github.com/Codium-ai/pr-agent/blob/main/Usage.md#github-app-automatic-tools), or it can be invoked manually by commenting on any PR:
|
||||||
```
|
```
|
||||||
/improve
|
/improve
|
||||||
```
|
```
|
||||||
|
|
||||||
### Summarized vs commitable code suggestions
|
For example:
|
||||||
|
|
||||||
The code suggestions can be presented as a single comment (via `pr_code_suggestions.summarize=true`):
|
<kbd><img src=https://codium.ai/images/pr_agent/improve_comment.png width="768"></kbd>
|
||||||
___
|
|
||||||
<kbd><img src=https://codium.ai/images/pr_agent/code_suggestions_as_comment.png width="768"></kbd>
|
---
|
||||||
___
|
|
||||||
|
|
||||||
Or as a separate commitable code comment for each suggestion:
|
|
||||||
___
|
|
||||||
<kbd><img src=https://codium.ai/images/pr_agent/improve.png width="768"></kbd>
|
<kbd><img src=https://codium.ai/images/pr_agent/improve.png width="768"></kbd>
|
||||||
|
|
||||||
---
|
---
|
||||||
Note that a single comment has a significantly smaller PR footprint. We recommend this mode for most cases.
|
|
||||||
Also note that collapsible are not supported in _Bitbucket_. Hence, the suggestions are presented there as code comments.
|
|
||||||
|
|
||||||
### Extended mode
|
|
||||||
|
|
||||||
An extended mode, which does not involve PR Compression and provides more comprehensive suggestions, can be invoked by commenting on any PR:
|
An extended mode, which does not involve PR Compression and provides more comprehensive suggestions, can be invoked by commenting on any PR:
|
||||||
```
|
```
|
||||||
@ -51,8 +44,8 @@ To edit [configurations](./../pr_agent/settings/configuration.toml#L66) related
|
|||||||
- `num_code_suggestions`: number of code suggestions provided by the 'improve' tool. Default is 4.
|
- `num_code_suggestions`: number of code suggestions provided by the 'improve' tool. Default is 4.
|
||||||
- `extra_instructions`: Optional extra instructions to the tool. For example: "focus on the changes in the file X. Ignore change in ...".
|
- `extra_instructions`: Optional extra instructions to the tool. For example: "focus on the changes in the file X. Ignore change in ...".
|
||||||
- `rank_suggestions`: if set to true, the tool will rank the suggestions, based on importance. Default is false.
|
- `rank_suggestions`: if set to true, the tool will rank the suggestions, based on importance. Default is false.
|
||||||
- `summarize`: if set to true, the tool will display the suggestions in a single comment. Default is false.
|
- `include_improved_code`: if set to true, the tool will include an improved code implementation in the suggestion. Default is true.
|
||||||
- `enable_help_text`: if set to true, the tool will display a help text in the comment. Default is true.
|
|
||||||
#### params for '/improve --extended' mode
|
#### params for '/improve --extended' mode
|
||||||
- `auto_extended_mode`: enable extended mode automatically (no need for the `--extended` option). Default is false.
|
- `auto_extended_mode`: enable extended mode automatically (no need for the `--extended` option). Default is false.
|
||||||
- `num_code_suggestions_per_chunk`: number of code suggestions provided by the 'improve' tool, per chunk. Default is 8.
|
- `num_code_suggestions_per_chunk`: number of code suggestions provided by the 'improve' tool, per chunk. Default is 8.
|
||||||
@ -60,6 +53,19 @@ To edit [configurations](./../pr_agent/settings/configuration.toml#L66) related
|
|||||||
- `max_number_of_calls`: maximum number of chunks. Default is 5.
|
- `max_number_of_calls`: maximum number of chunks. Default is 5.
|
||||||
- `final_clip_factor`: factor to remove suggestions with low confidence. Default is 0.9.
|
- `final_clip_factor`: factor to remove suggestions with low confidence. Default is 0.9.
|
||||||
|
|
||||||
|
#### Summarize mode
|
||||||
|
In this mode, instead of presenting committable suggestions, the different suggestions will be combined into a single compact comment, with significantly smaller PR footprint.
|
||||||
|
|
||||||
|
To invoke the summarize mode, use the following command:
|
||||||
|
```
|
||||||
|
/improve --pr_code_suggestions.summarize=true
|
||||||
|
```
|
||||||
|
|
||||||
|
For example:
|
||||||
|
|
||||||
|
<kbd><img src=https://codium.ai/images/pr_agent/improved_summerize_open.png width="768"></kbd>
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
## Usage Tips
|
## Usage Tips
|
||||||
|
|
||||||
@ -73,7 +79,7 @@ Examples for extra instructions:
|
|||||||
[pr_code_suggestions] # /improve #
|
[pr_code_suggestions] # /improve #
|
||||||
extra_instructions="""
|
extra_instructions="""
|
||||||
Emphasize the following aspects:
|
Emphasize the following aspects:
|
||||||
- Does the code logic cover relevant edge cases?
|
- Does the code logic covers relevant edge cases?
|
||||||
- Is the code logic clear and easy to understand?
|
- Is the code logic clear and easy to understand?
|
||||||
- Is the code logic efficient?
|
- Is the code logic efficient?
|
||||||
...
|
...
|
||||||
@ -81,6 +87,10 @@ Emphasize the following aspects:
|
|||||||
```
|
```
|
||||||
Use triple quotes to write multi-line instructions. Use bullet points to make the instructions more readable.
|
Use triple quotes to write multi-line instructions. Use bullet points to make the instructions more readable.
|
||||||
|
|
||||||
|
### PR footprint - regular vs summarize mode
|
||||||
|
The default mode of the `improve` tool provides committable suggestions. This mode as a high PR footprint, since each suggestion is a separate comment you need to resolve.
|
||||||
|
If you prefer something more compact, use the [`summarize`](#summarize-mode) mode, which combines all the suggestions into a single comment.
|
||||||
|
|
||||||
### A note on code suggestions quality
|
### A note on code suggestions quality
|
||||||
|
|
||||||
- While the current AI for code is getting better and better (GPT-4), it's not flawless. Not all the suggestions will be perfect, and a user should not accept all of them automatically.
|
- While the current AI for code is getting better and better (GPT-4), it's not flawless. Not all the suggestions will be perfect, and a user should not accept all of them automatically.
|
||||||
|
|||||||
@ -42,14 +42,14 @@ To edit [configurations](./../pr_agent/settings/configuration.toml#L19) related
|
|||||||
- `require_score_review`: if set to true, the tool will add a section that scores the PR. Default is false.
|
- `require_score_review`: if set to true, the tool will add a section that scores the PR. Default is false.
|
||||||
- `require_tests_review`: if set to true, the tool will add a section that checks if the PR contains tests. Default is true.
|
- `require_tests_review`: if set to true, the tool will add a section that checks if the PR contains tests. Default is true.
|
||||||
- `require_security_review`: if set to true, the tool will add a section that checks if the PR contains security issues. Default is true.
|
- `require_security_review`: if set to true, the tool will add a section that checks if the PR contains security issues. Default is true.
|
||||||
- `require_estimate_effort_to_review`: if set to true, the tool will add a section that estimates the effort needed to review the PR. Default is true.
|
- `require_estimate_effort_to_review`: if set to true, the tool will add a section that estimates thed effort needed to review the PR. Default is true.
|
||||||
#### SOC2 ticket compliance 💎
|
#### SOC2 ticket compliance 💎
|
||||||
This sub-tool checks if the PR description properly contains a ticket to a project management system (e.g., Jira, Asana, Trello, etc.), as required by SOC2 compliance. If not, it will add a label to the PR: "Missing SOC2 ticket".
|
This sub-tool checks if the PR description properly contains a ticket to a project management system (e.g., Jira, Asana, Trello, etc.), as required by SOC2 compliance. If not, it will add a label to the PR: "Missing SOC2 ticket".
|
||||||
- `require_soc2_ticket`: If set to true, the SOC2 ticket checker sub-tool will be enabled. Default is false.
|
- `require_soc2_review`: If set to true, the SOC2 ticket checker sub-tool will be enabled. Default is false.
|
||||||
- `soc2_ticket_prompt`: The prompt for the SOC2 ticket review. Default is: `Does the PR description include a link to ticket in a project management system (e.g., Jira, Asana, Trello, etc.) ?`. Edit this field if your compliance requirements are different.
|
- `soc2_ticket_prompt`: The prompt for the SOC2 ticket review. Default is: `Does the PR description include a link to ticket in a project management system (e.g., Jira, Asana, Trello, etc.) ?`. Edit this field if your compliance requirements are different.
|
||||||
#### Adding PR labels
|
#### Adding PR labels
|
||||||
- `enable_review_labels_security`: if set to true, the tool will publish a 'possible security issue' label if it detects a security issue. Default is true.
|
- `enable_review_labels_security`: if set to true, the tool will publish a 'possible security issue' label if it detects a security issue. Default is true.
|
||||||
- `enable_review_labels_effort`: if set to true, the tool will publish a 'Review effort [1-5]: x' label. Default is true.
|
- `enable_review_labels_effort`: if set to true, the tool will publish a 'Review effort [1-5]: x' label. Default is false.
|
||||||
|
|
||||||
### Incremental Mode
|
### Incremental Mode
|
||||||
Incremental review only considers changes since the last PR-Agent review. This can be useful when working on the PR in an iterative manner, and you want to focus on the changes since the last review instead of reviewing the entire PR again.
|
Incremental review only considers changes since the last PR-Agent review. This can be useful when working on the PR in an iterative manner, and you want to focus on the changes since the last review instead of reviewing the entire PR again.
|
||||||
@ -103,7 +103,7 @@ The `review` tool provides a collection of possible feedbacks about a PR.
|
|||||||
It is recommended to review the [Configuration options](#configuration-options) section, and choose the relevant options for your use case.
|
It is recommended to review the [Configuration options](#configuration-options) section, and choose the relevant options for your use case.
|
||||||
|
|
||||||
Some of the feature that are disabled by default are quite useful, and should be considered for enabling. For example:
|
Some of the feature that are disabled by default are quite useful, and should be considered for enabling. For example:
|
||||||
`require_score_review`, `require_soc2_ticket`, and more.
|
`require_score_review`, `require_soc2_review`, `enable_review_labels_effort`, and more.
|
||||||
|
|
||||||
On the other hand, if you find one of the enabled features to be irrelevant for your use case, disable it. No default configuration can fit all use cases.
|
On the other hand, if you find one of the enabled features to be irrelevant for your use case, disable it. No default configuration can fit all use cases.
|
||||||
|
|
||||||
@ -122,14 +122,14 @@ Edit this field to enable/disable the tool, or to change the used configurations
|
|||||||
|
|
||||||
### Auto-labels
|
### Auto-labels
|
||||||
The `review` tool can auto-generate two specific types of labels for a PR:
|
The `review` tool can auto-generate two specific types of labels for a PR:
|
||||||
- a `possible security issue` label that detects a possible [security issue](https://github.com/Codium-ai/pr-agent/blob/tr/user_description/pr_agent/settings/pr_reviewer_prompts.toml#L136) (`enable_review_labels_security` flag)
|
- a `possible security issue` label if it detects a [security issue](https://github.com/Codium-ai/pr-agent/blob/tr/user_description/pr_agent/settings/pr_reviewer_prompts.toml#L136) (`enable_review_labels_security` flag)
|
||||||
- a `Review effort [1-5]: x` label, where x is the estimated effort to review the PR (`enable_review_labels_effort` flag)
|
- a `Review effort [1-5]: x` label, where x is the estimated effort to review the PR (`enable_review_labels_effort` flag)
|
||||||
|
|
||||||
Both modes are useful, and we recommended to enable them.
|
Both modes are useful, and we recommended to enable them.
|
||||||
|
|
||||||
### Extra instructions
|
### Extra instructions
|
||||||
Extra instruction are important.
|
Extra instruction are important.
|
||||||
The `review` tool can be configured with extra instructions, which can be used to guide the model to a feedback tailored to the needs of your project.
|
The `review` tool can be configured with extra instructions, which can be used to guide the model to feedback tailored to the needs of your project.
|
||||||
|
|
||||||
Be specific, clear, and concise in the instructions. With extra instructions, you are the prompter. Specify the relevant sub-tool, and the relevant aspects of the PR that you want to emphasize.
|
Be specific, clear, and concise in the instructions. With extra instructions, you are the prompter. Specify the relevant sub-tool, and the relevant aspects of the PR that you want to emphasize.
|
||||||
|
|
||||||
@ -138,7 +138,7 @@ Examples for extra instructions:
|
|||||||
[pr_reviewer] # /review #
|
[pr_reviewer] # /review #
|
||||||
extra_instructions="""
|
extra_instructions="""
|
||||||
In the code feedback section, emphasize the following:
|
In the code feedback section, emphasize the following:
|
||||||
- Does the code logic cover relevant edge cases?
|
- Does the code logic covers relevant edge cases?
|
||||||
- Is the code logic clear and easy to understand?
|
- Is the code logic clear and easy to understand?
|
||||||
- Is the code logic efficient?
|
- Is the code logic efficient?
|
||||||
...
|
...
|
||||||
|
|||||||
30
docs/TEST.md
30
docs/TEST.md
@ -1,30 +0,0 @@
|
|||||||
# Test Tool 💎
|
|
||||||
By combining LLM abilities with static code analysis, the `test` tool generate tests for a selected component, based on the PR code changes.
|
|
||||||
It can be invoked manually by commenting on any PR:
|
|
||||||
```
|
|
||||||
/test component_name
|
|
||||||
```
|
|
||||||
where 'component_name' is the name of a specific component in the PR.
|
|
||||||
To get a list of the components that changed in the PR, use the [`analyze`](https://github.com/Codium-ai/pr-agent/blob/main/docs/Analyze.md) tool.
|
|
||||||
|
|
||||||
|
|
||||||
An example [result](https://github.com/Codium-ai/pr-agent/pull/598#issuecomment-1913679429):
|
|
||||||
|
|
||||||
<kbd><img src=https://codium.ai/images/pr_agent/test1.png width="704"></kbd>
|
|
||||||
___
|
|
||||||
<kbd><img src=https://codium.ai/images/pr_agent/test2.png width="768"></kbd>
|
|
||||||
___
|
|
||||||
<kbd><img src=https://codium.ai/images/pr_agent/test3.png width="768"></kbd>
|
|
||||||
|
|
||||||
Language that are currently supported by the tool: Python, Java, C++, JavaScript, TypeScript.
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
### Configuration options
|
|
||||||
- `num_tests`: number of tests to generate. Default is 3.
|
|
||||||
- `testing_framework`: the testing framework to use. If not set, for Python it will use `pytest`, for Java it will use `JUnit`, for C++ it will use `Catch2`, and for JavaScript and TypeScript it will use `jest`.
|
|
||||||
- `avoid_mocks`: if set to true, the tool will try to avoid using mocks in the generated tests. Note that even if this option is set to true, the tool might still use mocks if it cannot generate a test without them. Default is true.
|
|
||||||
- `extra_instructions`: Optional extra instructions to the tool. For example: "use the following mock injection scheme: ...".
|
|
||||||
- `file`: in case there are several components with the same name, you can specify the relevant file.
|
|
||||||
- `class_name`: in case there are several methods with the same name in the same file, you can specify the relevant class name.
|
|
||||||
- `enable_help_text`: if set to true, the tool will add a help text to the PR comment. Default is true.
|
|
||||||
@ -5,9 +5,8 @@
|
|||||||
- [ASK](./ASK.md)
|
- [ASK](./ASK.md)
|
||||||
- [SIMILAR_ISSUE](./SIMILAR_ISSUE.md)
|
- [SIMILAR_ISSUE](./SIMILAR_ISSUE.md)
|
||||||
- [UPDATE CHANGELOG](./UPDATE_CHANGELOG.md)
|
- [UPDATE CHANGELOG](./UPDATE_CHANGELOG.md)
|
||||||
- [ADD DOCUMENTATION](./ADD_DOCUMENTATION.md) 💎
|
- [ADD DOCUMENTATION](./ADD_DOCUMENTATION.md)
|
||||||
- [GENERATE CUSTOM LABELS](./GENERATE_CUSTOM_LABELS.md) 💎
|
- [GENERATE CUSTOM LABELS](./GENERATE_CUSTOM_LABELS.md)
|
||||||
- [Analyze](./Analyze.md) 💎
|
- [Analyze](./Analyze.md)
|
||||||
- [Test](./TEST.md) 💎
|
|
||||||
|
|
||||||
See the **[installation guide](/INSTALL.md)** for instructions on setting up PR-Agent.
|
See the **[installation guide](/INSTALL.md)** for instructions on how to setup PR-Agent.
|
||||||
@ -181,7 +181,7 @@ __old hunk__
|
|||||||
...
|
...
|
||||||
"""
|
"""
|
||||||
|
|
||||||
patch_with_lines_str = f"\n\n## file: '{file.filename.strip()}'\n"
|
patch_with_lines_str = f"\n\n## {file.filename}\n"
|
||||||
patch_lines = patch.splitlines()
|
patch_lines = patch.splitlines()
|
||||||
RE_HUNK_HEADER = re.compile(
|
RE_HUNK_HEADER = re.compile(
|
||||||
r"^@@ -(\d+)(?:,(\d+))? \+(\d+)(?:,(\d+))? @@[ ]?(.*)")
|
r"^@@ -(\d+)(?:,(\d+))? \+(\d+)(?:,(\d+))? @@[ ]?(.*)")
|
||||||
@ -202,11 +202,11 @@ __old hunk__
|
|||||||
if new_content_lines:
|
if new_content_lines:
|
||||||
if prev_header_line:
|
if prev_header_line:
|
||||||
patch_with_lines_str += f'\n{prev_header_line}\n'
|
patch_with_lines_str += f'\n{prev_header_line}\n'
|
||||||
patch_with_lines_str = patch_with_lines_str.rstrip()+'\n__new hunk__\n'
|
patch_with_lines_str += '__new hunk__\n'
|
||||||
for i, line_new in enumerate(new_content_lines):
|
for i, line_new in enumerate(new_content_lines):
|
||||||
patch_with_lines_str += f"{start2 + i} {line_new}\n"
|
patch_with_lines_str += f"{start2 + i} {line_new}\n"
|
||||||
if old_content_lines:
|
if old_content_lines:
|
||||||
patch_with_lines_str = patch_with_lines_str.rstrip()+'\n__old hunk__\n'
|
patch_with_lines_str += '__old hunk__\n'
|
||||||
for line_old in old_content_lines:
|
for line_old in old_content_lines:
|
||||||
patch_with_lines_str += f"{line_old}\n"
|
patch_with_lines_str += f"{line_old}\n"
|
||||||
new_content_lines = []
|
new_content_lines = []
|
||||||
@ -236,11 +236,11 @@ __old hunk__
|
|||||||
if match and new_content_lines:
|
if match and new_content_lines:
|
||||||
if new_content_lines:
|
if new_content_lines:
|
||||||
patch_with_lines_str += f'\n{header_line}\n'
|
patch_with_lines_str += f'\n{header_line}\n'
|
||||||
patch_with_lines_str = patch_with_lines_str.rstrip()+ '\n__new hunk__\n'
|
patch_with_lines_str += '\n__new hunk__\n'
|
||||||
for i, line_new in enumerate(new_content_lines):
|
for i, line_new in enumerate(new_content_lines):
|
||||||
patch_with_lines_str += f"{start2 + i} {line_new}\n"
|
patch_with_lines_str += f"{start2 + i} {line_new}\n"
|
||||||
if old_content_lines:
|
if old_content_lines:
|
||||||
patch_with_lines_str = patch_with_lines_str.rstrip() + '\n__old hunk__\n'
|
patch_with_lines_str += '\n__old hunk__\n'
|
||||||
for line_old in old_content_lines:
|
for line_old in old_content_lines:
|
||||||
patch_with_lines_str += f"{line_old}\n"
|
patch_with_lines_str += f"{line_old}\n"
|
||||||
|
|
||||||
|
|||||||
@ -209,9 +209,9 @@ def pr_generate_compressed_diff(top_langs: list, token_handler: TokenHandler, mo
|
|||||||
|
|
||||||
if patch:
|
if patch:
|
||||||
if not convert_hunks_to_line_numbers:
|
if not convert_hunks_to_line_numbers:
|
||||||
patch_final = f"\n\n## file: '{file.filename.strip()}\n\n{patch.strip()}\n'"
|
patch_final = f"## {file.filename}\n\n{patch}\n"
|
||||||
else:
|
else:
|
||||||
patch_final = "\n\n" + patch.strip()
|
patch_final = patch
|
||||||
patches.append(patch_final)
|
patches.append(patch_final)
|
||||||
total_tokens += token_handler.count_tokens(patch_final)
|
total_tokens += token_handler.count_tokens(patch_final)
|
||||||
if get_settings().config.verbosity_level >= 2:
|
if get_settings().config.verbosity_level >= 2:
|
||||||
@ -375,13 +375,6 @@ def get_pr_multi_diffs(git_provider: GitProvider,
|
|||||||
for lang in pr_languages:
|
for lang in pr_languages:
|
||||||
sorted_files.extend(sorted(lang['files'], key=lambda x: x.tokens, reverse=True))
|
sorted_files.extend(sorted(lang['files'], key=lambda x: x.tokens, reverse=True))
|
||||||
|
|
||||||
|
|
||||||
# try first a single run with standard diff string, with patch extension, and no deletions
|
|
||||||
patches_extended, total_tokens, patches_extended_tokens = pr_generate_extended_diff(
|
|
||||||
pr_languages, token_handler, add_line_numbers_to_hunks=True)
|
|
||||||
if total_tokens + OUTPUT_BUFFER_TOKENS_SOFT_THRESHOLD < get_max_tokens(model):
|
|
||||||
return ["\n".join(patches_extended)]
|
|
||||||
|
|
||||||
patches = []
|
patches = []
|
||||||
final_diff_list = []
|
final_diff_list = []
|
||||||
total_tokens = token_handler.prompt_tokens
|
total_tokens = token_handler.prompt_tokens
|
||||||
|
|||||||
@ -116,7 +116,7 @@ def parse_code_suggestion(code_suggestions: dict, i: int = 0, gfm_supported: boo
|
|||||||
relevant_line = sub_value_list[0].lstrip('`').lstrip('[')
|
relevant_line = sub_value_list[0].lstrip('`').lstrip('[')
|
||||||
if len(sub_value_list) > 1:
|
if len(sub_value_list) > 1:
|
||||||
link = sub_value_list[1].rstrip(')').strip('`')
|
link = sub_value_list[1].rstrip(')').strip('`')
|
||||||
markdown_text += f"<td><a href='{link}'>{relevant_line}</a></td>"
|
markdown_text += f"<td><a href={link}>{relevant_line}</a></td>"
|
||||||
else:
|
else:
|
||||||
markdown_text += f"<td>{relevant_line}</td>"
|
markdown_text += f"<td>{relevant_line}</td>"
|
||||||
markdown_text += "</tr>"
|
markdown_text += "</tr>"
|
||||||
@ -475,12 +475,3 @@ def clip_tokens(text: str, max_tokens: int, add_three_dots=True) -> str:
|
|||||||
except Exception as e:
|
except Exception as e:
|
||||||
get_logger().warning(f"Failed to clip tokens: {e}")
|
get_logger().warning(f"Failed to clip tokens: {e}")
|
||||||
return text
|
return text
|
||||||
|
|
||||||
def replace_code_tags(text):
|
|
||||||
"""
|
|
||||||
Replace odd instances of ` with <code> and even instances of ` with </code>
|
|
||||||
"""
|
|
||||||
parts = text.split('`')
|
|
||||||
for i in range(1, len(parts), 2):
|
|
||||||
parts[i] = '<code>' + parts[i] + '</code>'
|
|
||||||
return ''.join(parts)
|
|
||||||
@ -3,51 +3,27 @@ from typing import Optional, Tuple
|
|||||||
from urllib.parse import urlparse
|
from urllib.parse import urlparse
|
||||||
|
|
||||||
from ..log import get_logger
|
from ..log import get_logger
|
||||||
from ..algo.language_handler import is_valid_file
|
|
||||||
from ..algo.utils import clip_tokens, load_large_diff
|
|
||||||
from ..config_loader import get_settings
|
|
||||||
from .git_provider import EDIT_TYPE, FilePatchInfo, GitProvider
|
|
||||||
|
|
||||||
AZURE_DEVOPS_AVAILABLE = True
|
AZURE_DEVOPS_AVAILABLE = True
|
||||||
|
|
||||||
try:
|
try:
|
||||||
# noinspection PyUnresolvedReferences
|
|
||||||
from msrest.authentication import BasicAuthentication
|
from msrest.authentication import BasicAuthentication
|
||||||
# noinspection PyUnresolvedReferences
|
|
||||||
from azure.devops.connection import Connection
|
from azure.devops.connection import Connection
|
||||||
# noinspection PyUnresolvedReferences
|
|
||||||
from azure.devops.v7_1.git.models import (
|
from azure.devops.v7_1.git.models import (
|
||||||
Comment,
|
Comment,
|
||||||
CommentThread,
|
CommentThread,
|
||||||
GitVersionDescriptor,
|
GitVersionDescriptor,
|
||||||
GitPullRequest,
|
GitPullRequest,
|
||||||
)
|
)
|
||||||
except ImportError:
|
except ImportError as e:
|
||||||
AZURE_DEVOPS_AVAILABLE = False
|
AZURE_DEVOPS_AVAILABLE = False
|
||||||
|
|
||||||
|
from ..algo.language_handler import is_valid_file
|
||||||
|
from ..algo.utils import clip_tokens, load_large_diff
|
||||||
|
from ..config_loader import get_settings
|
||||||
|
from .git_provider import EDIT_TYPE, FilePatchInfo, GitProvider
|
||||||
|
|
||||||
|
|
||||||
class AzureDevopsProvider(GitProvider):
|
class AzureDevopsProvider(GitProvider):
|
||||||
|
|
||||||
def __init__(
|
|
||||||
self, pr_url: Optional[str] = None, incremental: Optional[bool] = False
|
|
||||||
):
|
|
||||||
if not AZURE_DEVOPS_AVAILABLE:
|
|
||||||
raise ImportError(
|
|
||||||
"Azure DevOps provider is not available. Please install the required dependencies."
|
|
||||||
)
|
|
||||||
|
|
||||||
self.azure_devops_client = self._get_azure_devops_client()
|
|
||||||
|
|
||||||
self.workspace_slug = None
|
|
||||||
self.repo_slug = None
|
|
||||||
self.repo = None
|
|
||||||
self.pr_num = None
|
|
||||||
self.pr = None
|
|
||||||
self.temp_comments = []
|
|
||||||
self.incremental = incremental
|
|
||||||
if pr_url:
|
|
||||||
self.set_pr(pr_url)
|
|
||||||
|
|
||||||
def publish_code_suggestions(self, code_suggestions: list) -> bool:
|
def publish_code_suggestions(self, code_suggestions: list) -> bool:
|
||||||
"""
|
"""
|
||||||
Publishes code suggestions as comments on the PR.
|
Publishes code suggestions as comments on the PR.
|
||||||
@ -121,7 +97,7 @@ class AzureDevopsProvider(GitProvider):
|
|||||||
return False
|
return False
|
||||||
|
|
||||||
def get_pr_description_full(self) -> str:
|
def get_pr_description_full(self) -> str:
|
||||||
return self.pr.description
|
pass
|
||||||
|
|
||||||
def remove_comment(self, comment):
|
def remove_comment(self, comment):
|
||||||
try:
|
try:
|
||||||
@ -159,6 +135,26 @@ class AzureDevopsProvider(GitProvider):
|
|||||||
get_logger().exception(f"Failed to get labels, error: {e}")
|
get_logger().exception(f"Failed to get labels, error: {e}")
|
||||||
return []
|
return []
|
||||||
|
|
||||||
|
def __init__(
|
||||||
|
self, pr_url: Optional[str] = None, incremental: Optional[bool] = False
|
||||||
|
):
|
||||||
|
if not AZURE_DEVOPS_AVAILABLE:
|
||||||
|
raise ImportError(
|
||||||
|
"Azure DevOps provider is not available. Please install the required dependencies."
|
||||||
|
)
|
||||||
|
|
||||||
|
self.azure_devops_client = self._get_azure_devops_client()
|
||||||
|
|
||||||
|
self.workspace_slug = None
|
||||||
|
self.repo_slug = None
|
||||||
|
self.repo = None
|
||||||
|
self.pr_num = None
|
||||||
|
self.pr = None
|
||||||
|
self.temp_comments = []
|
||||||
|
self.incremental = incremental
|
||||||
|
if pr_url:
|
||||||
|
self.set_pr(pr_url)
|
||||||
|
|
||||||
def is_supported(self, capability: str) -> bool:
|
def is_supported(self, capability: str) -> bool:
|
||||||
if capability in [
|
if capability in [
|
||||||
"get_issue_comments",
|
"get_issue_comments",
|
||||||
@ -184,8 +180,7 @@ class AzureDevopsProvider(GitProvider):
|
|||||||
)
|
)
|
||||||
return contents
|
return contents
|
||||||
except Exception as e:
|
except Exception as e:
|
||||||
if get_settings().config.verbosity_level >= 2:
|
get_logger().exception("get repo settings error")
|
||||||
get_logger().error(f"Failed to get repo settings, error: {e}")
|
|
||||||
return ""
|
return ""
|
||||||
|
|
||||||
def get_files(self):
|
def get_files(self):
|
||||||
@ -305,6 +300,7 @@ class AzureDevopsProvider(GitProvider):
|
|||||||
)
|
)
|
||||||
)
|
)
|
||||||
|
|
||||||
|
self.diff_files = diff_files
|
||||||
return diff_files
|
return diff_files
|
||||||
except Exception as e:
|
except Exception as e:
|
||||||
print(f"Error: {str(e)}")
|
print(f"Error: {str(e)}")
|
||||||
@ -398,7 +394,7 @@ class AzureDevopsProvider(GitProvider):
|
|||||||
source_branch = pr_info.source_ref_name.split("/")[-1]
|
source_branch = pr_info.source_ref_name.split("/")[-1]
|
||||||
return source_branch
|
return source_branch
|
||||||
|
|
||||||
def get_pr_description(self, *, full: bool = True) -> str:
|
def get_pr_description(self, full=False):
|
||||||
max_tokens = get_settings().get("CONFIG.MAX_DESCRIPTION_TOKENS", None)
|
max_tokens = get_settings().get("CONFIG.MAX_DESCRIPTION_TOKENS", None)
|
||||||
if max_tokens:
|
if max_tokens:
|
||||||
return clip_tokens(self.pr.description, max_tokens)
|
return clip_tokens(self.pr.description, max_tokens)
|
||||||
@ -418,8 +414,13 @@ class AzureDevopsProvider(GitProvider):
|
|||||||
def remove_reaction(self, issue_comment_id: int, reaction_id: int) -> bool:
|
def remove_reaction(self, issue_comment_id: int, reaction_id: int) -> bool:
|
||||||
return True
|
return True
|
||||||
|
|
||||||
|
def get_issue_comments(self):
|
||||||
|
raise NotImplementedError(
|
||||||
|
"Azure DevOps provider does not support issue comments yet"
|
||||||
|
)
|
||||||
|
|
||||||
@staticmethod
|
@staticmethod
|
||||||
def _parse_pr_url(pr_url: str) -> Tuple[str, str, int]:
|
def _parse_pr_url(pr_url: str) -> Tuple[str, int]:
|
||||||
parsed_url = urlparse(pr_url)
|
parsed_url = urlparse(pr_url)
|
||||||
|
|
||||||
path_parts = parsed_url.path.strip("/").split("/")
|
path_parts = parsed_url.path.strip("/").split("/")
|
||||||
@ -438,8 +439,7 @@ class AzureDevopsProvider(GitProvider):
|
|||||||
|
|
||||||
return workspace_slug, repo_slug, pr_number
|
return workspace_slug, repo_slug, pr_number
|
||||||
|
|
||||||
@staticmethod
|
def _get_azure_devops_client(self):
|
||||||
def _get_azure_devops_client():
|
|
||||||
try:
|
try:
|
||||||
pat = get_settings().azure_devops.pat
|
pat = get_settings().azure_devops.pat
|
||||||
org = get_settings().azure_devops.org
|
org = get_settings().azure_devops.org
|
||||||
@ -472,7 +472,5 @@ class AzureDevopsProvider(GitProvider):
|
|||||||
try:
|
try:
|
||||||
pr_id = f"{self.workspace_slug}/{self.repo_slug}/{self.pr_num}"
|
pr_id = f"{self.workspace_slug}/{self.repo_slug}/{self.pr_num}"
|
||||||
return pr_id
|
return pr_id
|
||||||
except Exception as e:
|
except Exception:
|
||||||
if get_settings().config.verbosity_level >= 2:
|
|
||||||
get_logger().error(f"Failed to get pr id, error: {e}")
|
|
||||||
return ""
|
return ""
|
||||||
|
|||||||
@ -75,18 +75,15 @@ class GitProvider(ABC):
|
|||||||
def get_user_description(self) -> str:
|
def get_user_description(self) -> str:
|
||||||
description = (self.get_pr_description_full() or "").strip()
|
description = (self.get_pr_description_full() or "").strip()
|
||||||
description_lowercase = description.lower()
|
description_lowercase = description.lower()
|
||||||
get_logger().info(f"Existing description:\n{description_lowercase}")
|
|
||||||
|
|
||||||
# if the existing description wasn't generated by the pr-agent, just return it as-is
|
# if the existing description wasn't generated by the pr-agent, just return it as-is
|
||||||
if not self._is_generated_by_pr_agent(description_lowercase):
|
if not self._is_generated_by_pr_agent(description_lowercase):
|
||||||
get_logger().info(f"Existing description was not generated by the pr-agent")
|
|
||||||
return description
|
return description
|
||||||
|
|
||||||
# if the existing description was generated by the pr-agent, but it doesn't contain a user description,
|
# if the existing description was generated by the pr-agent, but it doesn't contain a user description,
|
||||||
# return nothing (empty string) because it means there is no user description
|
# return nothing (empty string) because it means there is no user description
|
||||||
user_description_header = "## **user description**"
|
user_description_header = "## user description"
|
||||||
if user_description_header not in description_lowercase:
|
if user_description_header not in description_lowercase:
|
||||||
get_logger().info(f"Existing description was generated by the pr-agent, but it doesn't contain a user description")
|
|
||||||
return ""
|
return ""
|
||||||
|
|
||||||
# otherwise, extract the original user description from the existing pr-agent description and return it
|
# otherwise, extract the original user description from the existing pr-agent description and return it
|
||||||
@ -109,12 +106,11 @@ class GitProvider(ABC):
|
|||||||
if original_user_description.lower().startswith(user_description_header):
|
if original_user_description.lower().startswith(user_description_header):
|
||||||
original_user_description = original_user_description[len(user_description_header):].strip()
|
original_user_description = original_user_description[len(user_description_header):].strip()
|
||||||
|
|
||||||
get_logger().info(f"Extracted user description from existing description:\n{original_user_description}")
|
|
||||||
return original_user_description
|
return original_user_description
|
||||||
|
|
||||||
def _possible_headers(self):
|
def _possible_headers(self):
|
||||||
return ("## **user description**", "## **pr type**", "## **pr description**", "## **pr labels**", "## **type**", "## **description**",
|
return ("## user description", "## pr type", "## pr description", "## pr labels", "## type", "## description",
|
||||||
"## **labels**", "### 🤖 generated by pr agent")
|
"## labels", "### 🤖 generated by pr agent")
|
||||||
|
|
||||||
def _is_generated_by_pr_agent(self, description_lowercase: str) -> bool:
|
def _is_generated_by_pr_agent(self, description_lowercase: str) -> bool:
|
||||||
possible_headers = self._possible_headers()
|
possible_headers = self._possible_headers()
|
||||||
|
|||||||
@ -1,4 +1,3 @@
|
|||||||
import time
|
|
||||||
import hashlib
|
import hashlib
|
||||||
from datetime import datetime
|
from datetime import datetime
|
||||||
from typing import Optional, Tuple
|
from typing import Optional, Tuple
|
||||||
@ -222,114 +221,8 @@ class GithubProvider(GitProvider):
|
|||||||
path = relevant_file.strip()
|
path = relevant_file.strip()
|
||||||
return dict(body=body, path=path, position=position) if subject_type == "LINE" else {}
|
return dict(body=body, path=path, position=position) if subject_type == "LINE" else {}
|
||||||
|
|
||||||
def publish_inline_comments(self, comments: list[dict], disable_fallback: bool = False):
|
def publish_inline_comments(self, comments: list[dict]):
|
||||||
try:
|
|
||||||
# publish all comments in a single message
|
|
||||||
self.pr.create_review(commit=self.last_commit_id, comments=comments)
|
self.pr.create_review(commit=self.last_commit_id, comments=comments)
|
||||||
except Exception as e:
|
|
||||||
if get_settings().config.verbosity_level >= 2:
|
|
||||||
get_logger().error(f"Failed to publish inline comments")
|
|
||||||
|
|
||||||
if (getattr(e, "status", None) == 422
|
|
||||||
and get_settings().github.publish_inline_comments_fallback_with_verification and not disable_fallback):
|
|
||||||
pass # continue to try _publish_inline_comments_fallback_with_verification
|
|
||||||
else:
|
|
||||||
raise e # will end up with publishing the comments one by one
|
|
||||||
|
|
||||||
try:
|
|
||||||
self._publish_inline_comments_fallback_with_verification(comments)
|
|
||||||
except Exception as e:
|
|
||||||
if get_settings().config.verbosity_level >= 2:
|
|
||||||
get_logger().error(f"Failed to publish inline code comments fallback, error: {e}")
|
|
||||||
raise e
|
|
||||||
|
|
||||||
def _publish_inline_comments_fallback_with_verification(self, comments: list[dict]):
|
|
||||||
"""
|
|
||||||
Check each inline comment separately against the GitHub API and discard of invalid comments,
|
|
||||||
then publish all the remaining valid comments in a single review.
|
|
||||||
For invalid comments, also try removing the suggestion part and posting the comment just on the first line.
|
|
||||||
"""
|
|
||||||
verified_comments, invalid_comments = self._verify_code_comments(comments)
|
|
||||||
|
|
||||||
# publish as a group the verified comments
|
|
||||||
if verified_comments:
|
|
||||||
try:
|
|
||||||
self.pr.create_review(commit=self.last_commit_id, comments=verified_comments)
|
|
||||||
except:
|
|
||||||
pass
|
|
||||||
|
|
||||||
# try to publish one by one the invalid comments as a one-line code comment
|
|
||||||
if invalid_comments and get_settings().github.try_fix_invalid_inline_comments:
|
|
||||||
fixed_comments_as_one_liner = self._try_fix_invalid_inline_comments(
|
|
||||||
[comment for comment, _ in invalid_comments])
|
|
||||||
for comment in fixed_comments_as_one_liner:
|
|
||||||
try:
|
|
||||||
self.publish_inline_comments([comment], disable_fallback=True)
|
|
||||||
if get_settings().config.verbosity_level >= 2:
|
|
||||||
get_logger().info(f"Published invalid comment as a single line comment: {comment}")
|
|
||||||
except:
|
|
||||||
if get_settings().config.verbosity_level >= 2:
|
|
||||||
get_logger().error(f"Failed to publish invalid comment as a single line comment: {comment}")
|
|
||||||
|
|
||||||
def _verify_code_comment(self, comment: dict):
|
|
||||||
is_verified = False
|
|
||||||
e = None
|
|
||||||
try:
|
|
||||||
# event ="" # By leaving this blank, you set the review action state to PENDING
|
|
||||||
input = dict(commit_id=self.last_commit_id.sha, comments=[comment])
|
|
||||||
headers, data = self.pr._requester.requestJsonAndCheck(
|
|
||||||
"POST", f"{self.pr.url}/reviews", input=input)
|
|
||||||
pending_review_id = data["id"]
|
|
||||||
is_verified = True
|
|
||||||
except Exception as err:
|
|
||||||
is_verified = False
|
|
||||||
pending_review_id = None
|
|
||||||
e = err
|
|
||||||
if pending_review_id is not None:
|
|
||||||
try:
|
|
||||||
self.pr._requester.requestJsonAndCheck("DELETE", f"{self.pr.url}/reviews/{pending_review_id}")
|
|
||||||
except Exception:
|
|
||||||
pass
|
|
||||||
return is_verified, e
|
|
||||||
|
|
||||||
def _verify_code_comments(self, comments: list[dict]) -> tuple[list[dict], list[tuple[dict, Exception]]]:
|
|
||||||
"""Very each comment against the GitHub API and return 2 lists: 1 of verified and 1 of invalid comments"""
|
|
||||||
verified_comments = []
|
|
||||||
invalid_comments = []
|
|
||||||
for comment in comments:
|
|
||||||
time.sleep(1) # for avoiding secondary rate limit
|
|
||||||
is_verified, e = self._verify_code_comment(comment)
|
|
||||||
if is_verified:
|
|
||||||
verified_comments.append(comment)
|
|
||||||
else:
|
|
||||||
invalid_comments.append((comment, e))
|
|
||||||
return verified_comments, invalid_comments
|
|
||||||
|
|
||||||
def _try_fix_invalid_inline_comments(self, invalid_comments: list[dict]) -> list[dict]:
|
|
||||||
"""
|
|
||||||
Try fixing invalid comments by removing the suggestion part and setting the comment just on the first line.
|
|
||||||
Return only comments that have been modified in some way.
|
|
||||||
This is a best-effort attempt to fix invalid comments, and should be verified accordingly.
|
|
||||||
"""
|
|
||||||
import copy
|
|
||||||
fixed_comments = []
|
|
||||||
for comment in invalid_comments:
|
|
||||||
try:
|
|
||||||
fixed_comment = copy.deepcopy(comment) # avoid modifying the original comment dict for later logging
|
|
||||||
if "```suggestion" in comment["body"]:
|
|
||||||
fixed_comment["body"] = comment["body"].split("```suggestion")[0]
|
|
||||||
if "start_line" in comment:
|
|
||||||
fixed_comment["line"] = comment["start_line"]
|
|
||||||
del fixed_comment["start_line"]
|
|
||||||
if "start_side" in comment:
|
|
||||||
fixed_comment["side"] = comment["start_side"]
|
|
||||||
del fixed_comment["start_side"]
|
|
||||||
if fixed_comment != comment:
|
|
||||||
fixed_comments.append(fixed_comment)
|
|
||||||
except Exception as e:
|
|
||||||
if get_settings().config.verbosity_level >= 2:
|
|
||||||
get_logger().error(f"Failed to fix inline comment, error: {e}")
|
|
||||||
return fixed_comments
|
|
||||||
|
|
||||||
def publish_code_suggestions(self, code_suggestions: list) -> bool:
|
def publish_code_suggestions(self, code_suggestions: list) -> bool:
|
||||||
"""
|
"""
|
||||||
@ -373,7 +266,7 @@ class GithubProvider(GitProvider):
|
|||||||
post_parameters_list.append(post_parameters)
|
post_parameters_list.append(post_parameters)
|
||||||
|
|
||||||
try:
|
try:
|
||||||
self.publish_inline_comments(post_parameters_list)
|
self.pr.create_review(commit=self.last_commit_id, comments=post_parameters_list)
|
||||||
return True
|
return True
|
||||||
except Exception as e:
|
except Exception as e:
|
||||||
if get_settings().config.verbosity_level >= 2:
|
if get_settings().config.verbosity_level >= 2:
|
||||||
|
|||||||
@ -440,11 +440,11 @@ class GitLabProvider(GitProvider):
|
|||||||
|
|
||||||
def get_line_link(self, relevant_file: str, relevant_line_start: int, relevant_line_end: int = None) -> str:
|
def get_line_link(self, relevant_file: str, relevant_line_start: int, relevant_line_end: int = None) -> str:
|
||||||
if relevant_line_start == -1:
|
if relevant_line_start == -1:
|
||||||
link = f"{self.gl.url}/{self.id_project}/-/blob/{self.mr.source_branch}/{relevant_file}?ref_type=heads"
|
link = f"https://gitlab.com/codiumai/pr-agent/-/blob/{self.mr.source_branch}/{relevant_file}?ref_type=heads"
|
||||||
elif relevant_line_end:
|
elif relevant_line_end:
|
||||||
link = f"{self.gl.url}/{self.id_project}/-/blob/{self.mr.source_branch}/{relevant_file}?ref_type=heads#L{relevant_line_start}-L{relevant_line_end}"
|
link = f"https://gitlab.com/codiumai/pr-agent/-/blob/{self.mr.source_branch}/{relevant_file}?ref_type=heads#L{relevant_line_start}-L{relevant_line_end}"
|
||||||
else:
|
else:
|
||||||
link = f"{self.gl.url}/{self.id_project}/-/blob/{self.mr.source_branch}/{relevant_file}?ref_type=heads#L{relevant_line_start}"
|
link = f"https://gitlab.com/codiumai/pr-agent/-/blob/{self.mr.source_branch}/{relevant_file}?ref_type=heads#L{relevant_line_start}"
|
||||||
return link
|
return link
|
||||||
|
|
||||||
|
|
||||||
@ -460,7 +460,7 @@ class GitLabProvider(GitProvider):
|
|||||||
|
|
||||||
if absolute_position != -1:
|
if absolute_position != -1:
|
||||||
# link to right file only
|
# link to right file only
|
||||||
link = f"{self.gl.url}/{self.id_project}/-/blob/{self.mr.source_branch}/{relevant_file}?ref_type=heads#L{absolute_position}"
|
link = f"https://gitlab.com/codiumai/pr-agent/-/blob/{self.mr.source_branch}/{relevant_file}?ref_type=heads#L{absolute_position}"
|
||||||
|
|
||||||
# # link to diff
|
# # link to diff
|
||||||
# sha_file = hashlib.sha1(relevant_file.encode('utf-8')).hexdigest()
|
# sha_file = hashlib.sha1(relevant_file.encode('utf-8')).hexdigest()
|
||||||
|
|||||||
@ -82,23 +82,14 @@ async def run_action():
|
|||||||
if action in ["opened", "reopened"]:
|
if action in ["opened", "reopened"]:
|
||||||
pr_url = event_payload.get("pull_request", {}).get("url")
|
pr_url = event_payload.get("pull_request", {}).get("url")
|
||||||
if pr_url:
|
if pr_url:
|
||||||
# legacy - supporting both GITHUB_ACTION and GITHUB_ACTION_CONFIG
|
|
||||||
auto_review = get_setting_or_env("GITHUB_ACTION.AUTO_REVIEW", None)
|
auto_review = get_setting_or_env("GITHUB_ACTION.AUTO_REVIEW", None)
|
||||||
if auto_review is None:
|
|
||||||
auto_review = get_setting_or_env("GITHUB_ACTION_CONFIG.AUTO_REVIEW", None)
|
|
||||||
auto_describe = get_setting_or_env("GITHUB_ACTION.AUTO_DESCRIBE", None)
|
|
||||||
if auto_describe is None:
|
|
||||||
auto_describe = get_setting_or_env("GITHUB_ACTION_CONFIG.AUTO_DESCRIBE", None)
|
|
||||||
auto_improve = get_setting_or_env("GITHUB_ACTION.AUTO_IMPROVE", None)
|
|
||||||
if auto_improve is None:
|
|
||||||
auto_improve = get_setting_or_env("GITHUB_ACTION_CONFIG.AUTO_IMPROVE", None)
|
|
||||||
|
|
||||||
# invoke by default all three tools
|
|
||||||
if auto_describe is None or is_true(auto_describe):
|
|
||||||
await PRDescription(pr_url).run()
|
|
||||||
if auto_review is None or is_true(auto_review):
|
if auto_review is None or is_true(auto_review):
|
||||||
await PRReviewer(pr_url).run()
|
await PRReviewer(pr_url).run()
|
||||||
if auto_improve is None or is_true(auto_improve):
|
auto_describe = get_setting_or_env("GITHUB_ACTION.AUTO_DESCRIBE", None)
|
||||||
|
if is_true(auto_describe):
|
||||||
|
await PRDescription(pr_url).run()
|
||||||
|
auto_improve = get_setting_or_env("GITHUB_ACTION.AUTO_IMPROVE", None)
|
||||||
|
if is_true(auto_improve):
|
||||||
await PRCodeSuggestions(pr_url).run()
|
await PRCodeSuggestions(pr_url).run()
|
||||||
|
|
||||||
# Handle issue comment event
|
# Handle issue comment event
|
||||||
|
|||||||
@ -7,6 +7,7 @@ from pr_agent.agent.pr_agent import PRAgent
|
|||||||
from pr_agent.config_loader import get_settings
|
from pr_agent.config_loader import get_settings
|
||||||
from pr_agent.git_providers import get_git_provider
|
from pr_agent.git_providers import get_git_provider
|
||||||
from pr_agent.log import LoggingFormat, get_logger, setup_logger
|
from pr_agent.log import LoggingFormat, get_logger, setup_logger
|
||||||
|
from pr_agent.servers.help import bot_help_text
|
||||||
|
|
||||||
setup_logger(fmt=LoggingFormat.JSON)
|
setup_logger(fmt=LoggingFormat.JSON)
|
||||||
NOTIFICATION_URL = "https://api.github.com/notifications"
|
NOTIFICATION_URL = "https://api.github.com/notifications"
|
||||||
@ -103,6 +104,8 @@ async def polling_loop():
|
|||||||
notify=lambda: git_provider.add_eyes_reaction(comment_id)) # noqa E501
|
notify=lambda: git_provider.add_eyes_reaction(comment_id)) # noqa E501
|
||||||
if not success:
|
if not success:
|
||||||
git_provider.set_pr(pr_url)
|
git_provider.set_pr(pr_url)
|
||||||
|
git_provider.publish_comment("### How to use PR-Agent\n" +
|
||||||
|
bot_help_text(user_id))
|
||||||
|
|
||||||
elif response.status != 304:
|
elif response.status != 304:
|
||||||
print(f"Failed to fetch notifications. Status code: {response.status}")
|
print(f"Failed to fetch notifications. Status code: {response.status}")
|
||||||
|
|||||||
@ -1,7 +1,4 @@
|
|||||||
class HelpMessage:
|
commands_text = "> - **/review**: Request a review of your Pull Request. \n" \
|
||||||
@staticmethod
|
|
||||||
def get_general_commands_text():
|
|
||||||
commands_text = "> - **/review**: Request a review of your Pull Request. \n" \
|
|
||||||
"> - **/describe**: Update the PR title and description based on the contents of the PR. \n" \
|
"> - **/describe**: Update the PR title and description based on the contents of the PR. \n" \
|
||||||
"> - **/improve [--extended]**: Suggest code improvements. Extended mode provides a higher quality feedback. \n" \
|
"> - **/improve [--extended]**: Suggest code improvements. Extended mode provides a higher quality feedback. \n" \
|
||||||
"> - **/ask \\<QUESTION\\>**: Ask a question about the PR. \n" \
|
"> - **/ask \\<QUESTION\\>**: Ask a question about the PR. \n" \
|
||||||
@ -10,319 +7,14 @@ class HelpMessage:
|
|||||||
"> - **/generate_labels** 💎: Generate labels for the PR based on the PR's contents. \n" \
|
"> - **/generate_labels** 💎: Generate labels for the PR based on the PR's contents. \n" \
|
||||||
"> - **/analyze** 💎: Automatically analyzes the PR, and presents changes walkthrough for each component. \n\n" \
|
"> - **/analyze** 💎: Automatically analyzes the PR, and presents changes walkthrough for each component. \n\n" \
|
||||||
">See the [tools guide](https://github.com/Codium-ai/pr-agent/blob/main/docs/TOOLS_GUIDE.md) for more details.\n" \
|
">See the [tools guide](https://github.com/Codium-ai/pr-agent/blob/main/docs/TOOLS_GUIDE.md) for more details.\n" \
|
||||||
">To list the possible configuration parameters, add a **/config** comment. \n"
|
">To edit any configuration parameter from the [configuration.toml](https://github.com/Codium-ai/pr-agent/blob/main/pr_agent/settings/configuration.toml), add --config_path=new_value. \n" \
|
||||||
return commands_text
|
">For example: /review --pr_reviewer.extra_instructions=\"focus on the file: ...\" \n" \
|
||||||
|
">To list the possible configuration parameters, add a **/config** comment. \n" \
|
||||||
|
|
||||||
|
|
||||||
@staticmethod
|
def bot_help_text(user: str):
|
||||||
def get_general_bot_help_text():
|
return f"> Tag me in a comment '@{user}' and add one of the following commands: \n" + commands_text
|
||||||
output = f"> To invoke the PR-Agent, add a comment using one of the following commands: \n{HelpMessage.get_general_commands_text()} \n"
|
|
||||||
return output
|
|
||||||
|
|
||||||
@staticmethod
|
|
||||||
def get_review_usage_guide():
|
|
||||||
output ="**Overview:**\n"
|
|
||||||
output +="The `review` tool scans the PR code changes, and generates a PR review. The tool can be triggered [automatically](https://github.com/Codium-ai/pr-agent/blob/main/Usage.md#github-app-automatic-tools) every time a new PR is opened, or can be invoked manually by commenting on any PR.\n"
|
|
||||||
output +="""\
|
|
||||||
When commenting, to edit [configurations](https://github.com/Codium-ai/pr-agent/blob/main/pr_agent/settings/configuration.toml#L19) related to the review tool (`pr_reviewer` section), use the following template:
|
|
||||||
```
|
|
||||||
/review --pr_reviewer.some_config1=... --pr_reviewer.some_config2=...
|
|
||||||
```
|
|
||||||
With a [configuration file](https://github.com/Codium-ai/pr-agent/blob/main/Usage.md#working-with-github-app), use the following template:
|
|
||||||
```
|
|
||||||
[pr_reviewer]
|
|
||||||
some_config1=...
|
|
||||||
some_config2=...
|
|
||||||
```
|
|
||||||
"""
|
|
||||||
output +="\n\n<table>"
|
|
||||||
|
|
||||||
# extra instructions
|
|
||||||
output += "<tr><td><details> <summary><strong> Utilizing extra instructions</strong></summary><hr>\n\n"
|
|
||||||
output += '''\
|
|
||||||
The `review` tool can be configured with extra instructions, which can be used to guide the model to a feedback tailored to the needs of your project.
|
|
||||||
|
|
||||||
Be specific, clear, and concise in the instructions. With extra instructions, you are the prompter. Specify the relevant sub-tool, and the relevant aspects of the PR that you want to emphasize.
|
|
||||||
|
|
||||||
Examples for extra instructions:
|
|
||||||
```
|
|
||||||
[pr_reviewer] # /review #
|
|
||||||
extra_instructions="""
|
|
||||||
In the 'general suggestions' section, emphasize the following:
|
|
||||||
- Does the code logic cover relevant edge cases?
|
|
||||||
- Is the code logic clear and easy to understand?
|
|
||||||
- Is the code logic efficient?
|
|
||||||
...
|
|
||||||
"""
|
|
||||||
```
|
|
||||||
Use triple quotes to write multi-line instructions. Use bullet points to make the instructions more readable.
|
|
||||||
'''
|
|
||||||
output += "\n\n</details></td></tr>\n\n"
|
|
||||||
|
|
||||||
# automation
|
|
||||||
output += "<tr><td><details> <summary><strong> How to enable\\disable automation</strong></summary><hr>\n\n"
|
|
||||||
output += """\
|
|
||||||
- When you first install PR-Agent app, the [default mode](https://github.com/Codium-ai/pr-agent/blob/main/Usage.md#github-app-automatic-tools) for the `review` tool is:
|
|
||||||
```
|
|
||||||
pr_commands = ["/review", ...]
|
|
||||||
```
|
|
||||||
meaning the `review` tool will run automatically on every PR, with the default configuration.
|
|
||||||
Edit this field to enable/disable the tool, or to change the used configurations
|
|
||||||
"""
|
|
||||||
output += "\n\n</details></td></tr>\n\n"
|
|
||||||
|
|
||||||
# # code feedback
|
|
||||||
# output += "<tr><td><details> <summary><strong> About the 'Code feedback' section</strong></summary><hr>\n\n"
|
|
||||||
# output+="""\
|
|
||||||
# The `review` tool provides several type of feedbacks, one of them is code suggestions.
|
|
||||||
# If you are interested **only** in the code suggestions, it is recommended to use the [`improve`](https://github.com/Codium-ai/pr-agent/blob/main/docs/IMPROVE.md) feature instead, since it dedicated only to code suggestions, and usually gives better results.
|
|
||||||
# Use the `review` tool if you want to get a more comprehensive feedback, which includes code suggestions as well.
|
|
||||||
# """
|
|
||||||
# output += "\n\n</details></td></tr>\n\n"
|
|
||||||
|
|
||||||
# auto-labels
|
|
||||||
output += "<tr><td><details> <summary><strong> Auto-labels</strong></summary><hr>\n\n"
|
|
||||||
output+="""\
|
|
||||||
The `review` tool can auto-generate two specific types of labels for a PR:
|
|
||||||
- a `possible security issue` label, that detects possible [security issues](https://github.com/Codium-ai/pr-agent/blob/tr/user_description/pr_agent/settings/pr_reviewer_prompts.toml#L136) (`enable_review_labels_security` flag)
|
|
||||||
- a `Review effort [1-5]: x` label, where x is the estimated effort to review the PR (`enable_review_labels_effort` flag)
|
|
||||||
"""
|
|
||||||
output += "\n\n</details></td></tr>\n\n"
|
|
||||||
|
|
||||||
# extra sub-tools
|
|
||||||
output += "<tr><td><details> <summary><strong> Extra sub-tools</strong></summary><hr>\n\n"
|
|
||||||
output += """\
|
|
||||||
The `review` tool provides a collection of possible feedbacks about a PR.
|
|
||||||
It is recommended to review the [possible options](https://github.com/Codium-ai/pr-agent/blob/main/docs/REVIEW.md#enabledisable-features), and choose the ones relevant for your use case.
|
|
||||||
Some of the feature that are disabled by default are quite useful, and should be considered for enabling. For example:
|
|
||||||
`require_score_review`, `require_soc2_ticket`, and more.
|
|
||||||
"""
|
|
||||||
output += "\n\n</details></td></tr>\n\n"
|
|
||||||
|
|
||||||
# general
|
|
||||||
output += "\n\n<tr><td><details> <summary><strong> More PR-Agent commands</strong></summary><hr> \n\n"
|
|
||||||
output += HelpMessage.get_general_bot_help_text()
|
|
||||||
output += "\n\n</details></td></tr>\n\n"
|
|
||||||
|
|
||||||
output += "</table>"
|
|
||||||
|
|
||||||
output += f"\n\nSee the [review usage](https://github.com/Codium-ai/pr-agent/blob/main/docs/REVIEW.md) page for a comprehensive guide on using this tool.\n\n"
|
|
||||||
|
|
||||||
return output
|
|
||||||
|
|
||||||
|
|
||||||
|
actions_help_text = "> To invoke the PR-Agent, add a comment using one of the following commands: \n" + \
|
||||||
@staticmethod
|
commands_text
|
||||||
def get_describe_usage_guide():
|
|
||||||
output = "**Overview:**\n"
|
|
||||||
output += "The `describe` tool scans the PR code changes, and generates a description for the PR - title, type, summary, walkthrough and labels. "
|
|
||||||
output += "The tool can be triggered [automatically](https://github.com/Codium-ai/pr-agent/blob/main/Usage.md#github-app-automatic-tools) every time a new PR is opened, or can be invoked manually by commenting on a PR.\n"
|
|
||||||
output += """\
|
|
||||||
|
|
||||||
When commenting, to edit [configurations](https://github.com/Codium-ai/pr-agent/blob/main/pr_agent/settings/configuration.toml#L46) related to the describe tool (`pr_description` section), use the following template:
|
|
||||||
```
|
|
||||||
/describe --pr_description.some_config1=... --pr_description.some_config2=...
|
|
||||||
```
|
|
||||||
With a [configuration file](https://github.com/Codium-ai/pr-agent/blob/main/Usage.md#working-with-github-app), use the following template:
|
|
||||||
```
|
|
||||||
[pr_description]
|
|
||||||
some_config1=...
|
|
||||||
some_config2=...
|
|
||||||
```
|
|
||||||
"""
|
|
||||||
output += "\n\n<table>"
|
|
||||||
|
|
||||||
# automation
|
|
||||||
output += "<tr><td><details> <summary><strong> Enabling\\disabling automation </strong></summary><hr>\n\n"
|
|
||||||
output += """\
|
|
||||||
- When you first install the app, the [default mode](https://github.com/Codium-ai/pr-agent/blob/main/Usage.md#github-app-automatic-tools) for the describe tool is:
|
|
||||||
```
|
|
||||||
pr_commands = ["/describe --pr_description.add_original_user_description=true"
|
|
||||||
"--pr_description.keep_original_user_title=true", ...]
|
|
||||||
```
|
|
||||||
meaning the `describe` tool will run automatically on every PR, will keep the original title, and will add the original user description above the generated description.
|
|
||||||
|
|
||||||
- Markers are an alternative way to control the generated description, to give maximal control to the user. If you set:
|
|
||||||
```
|
|
||||||
pr_commands = ["/describe --pr_description.use_description_markers=true", ...]
|
|
||||||
```
|
|
||||||
the tool will replace every marker of the form `pr_agent:marker_name` in the PR description with the relevant content, where `marker_name` is one of the following:
|
|
||||||
- `type`: the PR type.
|
|
||||||
- `summary`: the PR summary.
|
|
||||||
- `walkthrough`: the PR walkthrough.
|
|
||||||
|
|
||||||
Note that when markers are enabled, if the original PR description does not contain any markers, the tool will not alter the description at all.
|
|
||||||
|
|
||||||
"""
|
|
||||||
output += "\n\n</details></td></tr>\n\n"
|
|
||||||
|
|
||||||
# custom labels
|
|
||||||
output += "<tr><td><details> <summary><strong> Custom labels </strong></summary><hr>\n\n"
|
|
||||||
output += """\
|
|
||||||
The default labels of the `describe` tool are quite generic: [`Bug fix`, `Tests`, `Enhancement`, `Documentation`, `Other`].
|
|
||||||
|
|
||||||
If you specify [custom labels](https://github.com/Codium-ai/pr-agent/blob/main/docs/DESCRIBE.md#handle-custom-labels-from-the-repos-labels-page-gem) in the repo's labels page or via configuration file, you can get tailored labels for your use cases.
|
|
||||||
Examples for custom labels:
|
|
||||||
- `Main topic:performance` - pr_agent:The main topic of this PR is performance
|
|
||||||
- `New endpoint` - pr_agent:A new endpoint was added in this PR
|
|
||||||
- `SQL query` - pr_agent:A new SQL query was added in this PR
|
|
||||||
- `Dockerfile changes` - pr_agent:The PR contains changes in the Dockerfile
|
|
||||||
- ...
|
|
||||||
|
|
||||||
The list above is eclectic, and aims to give an idea of different possibilities. Define custom labels that are relevant for your repo and use cases.
|
|
||||||
Note that Labels are not mutually exclusive, so you can add multiple label categories.
|
|
||||||
Make sure to provide proper title, and a detailed and well-phrased description for each label, so the tool will know when to suggest it.
|
|
||||||
"""
|
|
||||||
output += "\n\n</details></td></tr>\n\n"
|
|
||||||
|
|
||||||
# Inline File Walkthrough
|
|
||||||
output += "<tr><td><details> <summary><strong> Inline File Walkthrough 💎</strong></summary><hr>\n\n"
|
|
||||||
output += """\
|
|
||||||
For enhanced user experience, the `describe` tool can add file summaries directly to the "Files changed" tab in the PR page.
|
|
||||||
This will enable you to quickly understand the changes in each file, while reviewing the code changes (diffs).
|
|
||||||
|
|
||||||
To enable inline file summary, set `pr_description.inline_file_summary` in the configuration file, possible values are:
|
|
||||||
- `'table'`: File changes walkthrough table will be displayed on the top of the "Files changed" tab, in addition to the "Conversation" tab.
|
|
||||||
- `true`: A collapsable file comment with changes title and a changes summary for each file in the PR.
|
|
||||||
- `false` (default): File changes walkthrough will be added only to the "Conversation" tab.
|
|
||||||
"""
|
|
||||||
# extra instructions
|
|
||||||
output += "<tr><td><details> <summary><strong> Utilizing extra instructions</strong></summary><hr>\n\n"
|
|
||||||
output += '''\
|
|
||||||
The `describe` tool can be configured with extra instructions, to guide the model to a feedback tailored to the needs of your project.
|
|
||||||
|
|
||||||
Be specific, clear, and concise in the instructions. With extra instructions, you are the prompter. Notice that the general structure of the description is fixed, and cannot be changed. Extra instructions can change the content or style of each sub-section of the PR description.
|
|
||||||
|
|
||||||
Examples for extra instructions:
|
|
||||||
```
|
|
||||||
[pr_description]
|
|
||||||
extra_instructions="""
|
|
||||||
- The PR title should be in the format: '<PR type>: <title>'
|
|
||||||
- The title should be short and concise (up to 10 words)
|
|
||||||
- ...
|
|
||||||
"""
|
|
||||||
```
|
|
||||||
Use triple quotes to write multi-line instructions. Use bullet points to make the instructions more readable.
|
|
||||||
'''
|
|
||||||
output += "\n\n</details></td></tr>\n\n"
|
|
||||||
|
|
||||||
|
|
||||||
# general
|
|
||||||
output += "\n\n<tr><td><details> <summary><strong> More PR-Agent commands</strong></summary><hr> \n\n"
|
|
||||||
output += HelpMessage.get_general_bot_help_text()
|
|
||||||
output += "\n\n</details></td></tr>\n\n"
|
|
||||||
|
|
||||||
output += "</table>"
|
|
||||||
|
|
||||||
output += f"\n\nSee the [describe usage](https://github.com/Codium-ai/pr-agent/blob/main/docs/DESCRIBE.md) page for a comprehensive guide on using this tool.\n\n"
|
|
||||||
|
|
||||||
return output
|
|
||||||
|
|
||||||
@staticmethod
|
|
||||||
def get_ask_usage_guide():
|
|
||||||
output = "**Overview:**\n"
|
|
||||||
output += """\
|
|
||||||
The `ask` tool answers questions about the PR, based on the PR code changes.
|
|
||||||
It can be invoked manually by commenting on any PR:
|
|
||||||
```
|
|
||||||
/ask "..."
|
|
||||||
```
|
|
||||||
|
|
||||||
Note that the tool does not have "memory" of previous questions, and answers each question independently.
|
|
||||||
"""
|
|
||||||
output += "\n\n<table>"
|
|
||||||
|
|
||||||
# general
|
|
||||||
output += "\n\n<tr><td><details> <summary><strong> More PR-Agent commands</strong></summary><hr> \n\n"
|
|
||||||
output += HelpMessage.get_general_bot_help_text()
|
|
||||||
output += "\n\n</details></td></tr>\n\n"
|
|
||||||
|
|
||||||
output += "</table>"
|
|
||||||
|
|
||||||
output += f"\n\nSee the [ask usage](https://github.com/Codium-ai/pr-agent/blob/main/docs/ASK.md) page for a comprehensive guide on using this tool.\n\n"
|
|
||||||
|
|
||||||
return output
|
|
||||||
|
|
||||||
|
|
||||||
@staticmethod
|
|
||||||
def get_improve_usage_guide():
|
|
||||||
output = "**Overview:**\n"
|
|
||||||
output += "The `improve` tool scans the PR code changes, and automatically generates suggestions for improving the PR code. "
|
|
||||||
output += "The tool can be triggered [automatically](https://github.com/Codium-ai/pr-agent/blob/main/Usage.md#github-app-automatic-tools) every time a new PR is opened, or can be invoked manually by commenting on a PR.\n"
|
|
||||||
output += """\
|
|
||||||
When commenting, to edit [configurations](https://github.com/Codium-ai/pr-agent/blob/main/pr_agent/settings/configuration.toml#L69) related to the improve tool (`pr_code_suggestions` section), use the following template:
|
|
||||||
|
|
||||||
```
|
|
||||||
/improve --pr_code_suggestions.some_config1=... --pr_code_suggestions.some_config2=...
|
|
||||||
```
|
|
||||||
|
|
||||||
With a [configuration file](https://github.com/Codium-ai/pr-agent/blob/main/Usage.md#working-with-github-app), use the following template:
|
|
||||||
|
|
||||||
```
|
|
||||||
[pr_code_suggestions]
|
|
||||||
some_config1=...
|
|
||||||
some_config2=...
|
|
||||||
```
|
|
||||||
|
|
||||||
"""
|
|
||||||
output += "\n\n<table>"
|
|
||||||
|
|
||||||
# automation
|
|
||||||
output += "<tr><td><details> <summary><strong> Enabling\\disabling automation </strong></summary><hr>\n\n"
|
|
||||||
output += """\
|
|
||||||
When you first install the app, the [default mode](https://github.com/Codium-ai/pr-agent/blob/main/Usage.md#github-app-automatic-tools) for the improve tool is:
|
|
||||||
|
|
||||||
```
|
|
||||||
pr_commands = ["/improve --pr_code_suggestions.summarize=true", ...]
|
|
||||||
```
|
|
||||||
|
|
||||||
meaning the `improve` tool will run automatically on every PR, with summarization enabled. Delete this line to disable the tool from running automatically.
|
|
||||||
"""
|
|
||||||
output += "\n\n</details></td></tr>\n\n"
|
|
||||||
|
|
||||||
# extra instructions
|
|
||||||
output += "<tr><td><details> <summary><strong> Utilizing extra instructions</strong></summary><hr>\n\n"
|
|
||||||
output += '''\
|
|
||||||
Extra instructions are very important for the `improve` tool, since they enable to guide the model to suggestions that are more relevant to the specific needs of the project.
|
|
||||||
|
|
||||||
Be specific, clear, and concise in the instructions. With extra instructions, you are the prompter. Specify relevant aspects that you want the model to focus on.
|
|
||||||
|
|
||||||
Examples for extra instructions:
|
|
||||||
|
|
||||||
```
|
|
||||||
[pr_code_suggestions] # /improve #
|
|
||||||
extra_instructions="""
|
|
||||||
Emphasize the following aspects:
|
|
||||||
- Does the code logic cover relevant edge cases?
|
|
||||||
- Is the code logic clear and easy to understand?
|
|
||||||
- Is the code logic efficient?
|
|
||||||
...
|
|
||||||
"""
|
|
||||||
```
|
|
||||||
|
|
||||||
Use triple quotes to write multi-line instructions. Use bullet points to make the instructions more readable.
|
|
||||||
'''
|
|
||||||
output += "\n\n</details></td></tr>\n\n"
|
|
||||||
|
|
||||||
# suggestions quality
|
|
||||||
output += "\n\n<tr><td><details> <summary><strong> A note on code suggestions quality</strong></summary><hr> \n\n"
|
|
||||||
output += """\
|
|
||||||
- While the current AI for code is getting better and better (GPT-4), it's not flawless. Not all the suggestions will be perfect, and a user should not accept all of them automatically.
|
|
||||||
- Suggestions are not meant to be simplistic. Instead, they aim to give deep feedback and raise questions, ideas and thoughts to the user, who can then use his judgment, experience, and understanding of the code base.
|
|
||||||
- Recommended to use the 'extra_instructions' field to guide the model to suggestions that are more relevant to the specific needs of the project, or use the [custom suggestions :gem:](https://github.com/Codium-ai/pr-agent/blob/main/docs/CUSTOM_SUGGESTIONS.md) tool
|
|
||||||
- With large PRs, best quality will be obtained by using 'improve --extended' mode.
|
|
||||||
|
|
||||||
|
|
||||||
"""
|
|
||||||
output += "\n\n</details></td></tr>\n\n"\
|
|
||||||
|
|
||||||
# general
|
|
||||||
output += "\n\n<tr><td><details> <summary><strong> More PR-Agent commands</strong></summary><hr> \n\n"
|
|
||||||
output += HelpMessage.get_general_bot_help_text()
|
|
||||||
output += "\n\n</details></td></tr>\n\n"
|
|
||||||
|
|
||||||
output += "</table>"
|
|
||||||
|
|
||||||
output += f"\n\nSee the [improve usage](https://github.com/Codium-ai/pr-agent/blob/main/docs/IMPROVE.md) page for a more comprehensive guide on using this tool.\n\n"
|
|
||||||
|
|
||||||
return output
|
|
||||||
|
|||||||
@ -1,5 +1,5 @@
|
|||||||
[config]
|
[config]
|
||||||
model="gpt-4" # "gpt-4-0125-preview"
|
model="gpt-4" # "gpt-4-1106-preview"
|
||||||
fallback_models=["gpt-3.5-turbo-16k"]
|
fallback_models=["gpt-3.5-turbo-16k"]
|
||||||
git_provider="github"
|
git_provider="github"
|
||||||
publish_output=true
|
publish_output=true
|
||||||
@ -36,7 +36,7 @@ persistent_comment=true
|
|||||||
extra_instructions = ""
|
extra_instructions = ""
|
||||||
# review labels
|
# review labels
|
||||||
enable_review_labels_security=true
|
enable_review_labels_security=true
|
||||||
enable_review_labels_effort=true
|
enable_review_labels_effort=false
|
||||||
# specific configurations for incremental review (/review -i)
|
# specific configurations for incremental review (/review -i)
|
||||||
require_all_thresholds_for_incremental_review=false
|
require_all_thresholds_for_incremental_review=false
|
||||||
minimal_commits_for_incremental_review=0
|
minimal_commits_for_incremental_review=0
|
||||||
@ -46,17 +46,15 @@ enable_help_text=true # Determines whether to include help text in the PR review
|
|||||||
[pr_description] # /describe #
|
[pr_description] # /describe #
|
||||||
publish_labels=true
|
publish_labels=true
|
||||||
publish_description_as_comment=false
|
publish_description_as_comment=false
|
||||||
add_original_user_description=true
|
add_original_user_description=false
|
||||||
keep_original_user_title=true
|
keep_original_user_title=false
|
||||||
use_bullet_points=true
|
use_bullet_points=true
|
||||||
extra_instructions = ""
|
extra_instructions = ""
|
||||||
enable_pr_type=true
|
enable_pr_type=true
|
||||||
final_update_message = true
|
final_update_message = true
|
||||||
enable_help_text=true
|
|
||||||
## changes walkthrough section
|
## changes walkthrough section
|
||||||
enable_semantic_files_types=true
|
enable_semantic_files_types=true
|
||||||
collapsible_file_list='adaptive' # true, false, 'adaptive'
|
collapsible_file_list='adaptive' # true, false, 'adaptive'
|
||||||
inline_file_summary=false # false, true, 'table'
|
|
||||||
# markers
|
# markers
|
||||||
use_description_markers=false
|
use_description_markers=false
|
||||||
include_generated_by_header=true
|
include_generated_by_header=true
|
||||||
@ -64,15 +62,13 @@ include_generated_by_header=true
|
|||||||
#custom_labels = ['Bug fix', 'Tests', 'Bug fix with tests', 'Enhancement', 'Documentation', 'Other']
|
#custom_labels = ['Bug fix', 'Tests', 'Bug fix with tests', 'Enhancement', 'Documentation', 'Other']
|
||||||
|
|
||||||
[pr_questions] # /ask #
|
[pr_questions] # /ask #
|
||||||
enable_help_text=true
|
|
||||||
|
|
||||||
|
|
||||||
[pr_code_suggestions] # /improve #
|
[pr_code_suggestions] # /improve #
|
||||||
num_code_suggestions=4
|
num_code_suggestions=4
|
||||||
summarize = true
|
summarize = false
|
||||||
|
include_improved_code = true
|
||||||
extra_instructions = ""
|
extra_instructions = ""
|
||||||
rank_suggestions = false
|
rank_suggestions = false
|
||||||
enable_help_text=true
|
|
||||||
# params for '/improve --extended' mode
|
# params for '/improve --extended' mode
|
||||||
auto_extended_mode=false
|
auto_extended_mode=false
|
||||||
num_code_suggestions_per_chunk=8
|
num_code_suggestions_per_chunk=8
|
||||||
@ -90,15 +86,6 @@ extra_instructions = ""
|
|||||||
|
|
||||||
[pr_analyze] # /analyze #
|
[pr_analyze] # /analyze #
|
||||||
|
|
||||||
[pr_test] # /test #
|
|
||||||
extra_instructions = ""
|
|
||||||
testing_framework = "" # specify the testing framework you want to use
|
|
||||||
num_tests=3 # number of tests to generate. max 5.
|
|
||||||
avoid_mocks=true # if true, the generated tests will prefer to use real objects instead of mocks
|
|
||||||
file = "" # in case there are several components with the same name, you can specify the relevant file
|
|
||||||
class_name = "" # in case there are several methods with the same name in the same file, you can specify the relevant class name
|
|
||||||
enable_help_text=true
|
|
||||||
|
|
||||||
[pr_config] # /config #
|
[pr_config] # /config #
|
||||||
|
|
||||||
[github]
|
[github]
|
||||||
@ -106,10 +93,8 @@ enable_help_text=true
|
|||||||
deployment_type = "user"
|
deployment_type = "user"
|
||||||
ratelimit_retries = 5
|
ratelimit_retries = 5
|
||||||
base_url = "https://api.github.com"
|
base_url = "https://api.github.com"
|
||||||
publish_inline_comments_fallback_with_verification = true
|
|
||||||
try_fix_invalid_inline_comments = true
|
|
||||||
|
|
||||||
[github_action_config]
|
[github_action]
|
||||||
# auto_review = true # set as env var in .github/workflows/pr-agent.yaml
|
# auto_review = true # set as env var in .github/workflows/pr-agent.yaml
|
||||||
# auto_describe = true # set as env var in .github/workflows/pr-agent.yaml
|
# auto_describe = true # set as env var in .github/workflows/pr-agent.yaml
|
||||||
# auto_improve = true # set as env var in .github/workflows/pr-agent.yaml
|
# auto_improve = true # set as env var in .github/workflows/pr-agent.yaml
|
||||||
@ -126,8 +111,7 @@ duplicate_requests_cache_ttl = 60 # in seconds
|
|||||||
handle_pr_actions = ['opened', 'reopened', 'ready_for_review', 'review_requested']
|
handle_pr_actions = ['opened', 'reopened', 'ready_for_review', 'review_requested']
|
||||||
pr_commands = [
|
pr_commands = [
|
||||||
"/describe --pr_description.add_original_user_description=true --pr_description.keep_original_user_title=true",
|
"/describe --pr_description.add_original_user_description=true --pr_description.keep_original_user_title=true",
|
||||||
"/review --pr_reviewer.num_code_suggestions=0",
|
"/review",
|
||||||
"/improve --pr_code_suggestions.summarize=true",
|
|
||||||
]
|
]
|
||||||
# settings for "pull_request" event with "synchronize" action - used to detect and handle push triggers for new commits
|
# settings for "pull_request" event with "synchronize" action - used to detect and handle push triggers for new commits
|
||||||
handle_push_trigger = false
|
handle_push_trigger = false
|
||||||
|
|||||||
@ -5,7 +5,7 @@ Your task is to generate {{ docs_for_language }} for code components in the PR D
|
|||||||
|
|
||||||
Example for the PR Diff format:
|
Example for the PR Diff format:
|
||||||
======
|
======
|
||||||
## file: 'src/file1.py'
|
## src/file1.py
|
||||||
|
|
||||||
@@ -12,3 +12,4 @@ def func1():
|
@@ -12,3 +12,4 @@ def func1():
|
||||||
__new hunk__
|
__new hunk__
|
||||||
@ -18,6 +18,7 @@ __old hunk__
|
|||||||
-code line that was removed in the PR
|
-code line that was removed in the PR
|
||||||
code line2 that remained unchanged in the PR
|
code line2 that remained unchanged in the PR
|
||||||
|
|
||||||
|
|
||||||
@@ ... @@ def func2():
|
@@ ... @@ def func2():
|
||||||
__new hunk__
|
__new hunk__
|
||||||
...
|
...
|
||||||
@ -25,7 +26,7 @@ __old hunk__
|
|||||||
...
|
...
|
||||||
|
|
||||||
|
|
||||||
## file: 'src/file2.py'
|
## src/file2.py
|
||||||
...
|
...
|
||||||
======
|
======
|
||||||
|
|
||||||
|
|||||||
@ -4,17 +4,19 @@ Your task is to provide meaningful and actionable code suggestions, to improve t
|
|||||||
|
|
||||||
Example for the PR Diff format:
|
Example for the PR Diff format:
|
||||||
======
|
======
|
||||||
## file: 'src/file1.py'
|
## src/file1.py
|
||||||
|
|
||||||
@@ ... @@ def func1():
|
@@ -12,3 +12,4 @@ def func1():
|
||||||
__new hunk__
|
__new hunk__
|
||||||
12 code line1 that remained unchanged in the PR
|
12 code line1 that remained unchanged in the PR
|
||||||
13 +new code line2 added in the PR
|
14 +new code line1 added in the PR
|
||||||
14 code line3 that remained unchanged in the PR
|
15 +new code line2 added in the PR
|
||||||
|
16 code line2 that remained unchanged in the PR
|
||||||
__old hunk__
|
__old hunk__
|
||||||
code line1 that remained unchanged in the PR
|
code line1 that remained unchanged in the PR
|
||||||
-old code line2 that was removed in the PR
|
-code line that was removed in the PR
|
||||||
code line3 that remained unchanged in the PR
|
code line2 that remained unchanged in the PR
|
||||||
|
|
||||||
|
|
||||||
@@ ... @@ def func2():
|
@@ ... @@ def func2():
|
||||||
__new hunk__
|
__new hunk__
|
||||||
@ -23,18 +25,19 @@ __old hunk__
|
|||||||
...
|
...
|
||||||
|
|
||||||
|
|
||||||
## file: 'src/file2.py'
|
## src/file2.py
|
||||||
...
|
...
|
||||||
======
|
======
|
||||||
|
|
||||||
|
|
||||||
Specific instructions:
|
Specific instructions:
|
||||||
- Provide up to {{ num_code_suggestions }} code suggestions. The suggestions should be diverse and insightful.
|
- Provide up to {{ num_code_suggestions }} code suggestions. Try to provide diverse and insightful suggestions.
|
||||||
- The suggestions should refer only to code from the '__new hunk__' sections, and focus on new lines of code (lines starting with '+').
|
- Prioritize suggestions that address major problems, issues and bugs in the code. As a second priority, suggestions should focus on enhancement, best practice, performance, maintainability, and other aspects.
|
||||||
- Prioritize suggestions that address major problems, issues and bugs in the PR code. As a second priority, suggestions should focus on enhancement, best practice, performance, maintainability, and other aspects.
|
- Don't suggest to add docstring, type hints, or comments.
|
||||||
- Don't suggest to add docstring, type hints, or comments, or to remove unused imports.
|
- Suggestions should refer only to code from the '__new hunk__' sections, and focus on new lines of code (lines starting with '+').
|
||||||
- Avoid making suggestions that have already been implemented in the PR code. For example, if you want to add logs, or change a variable to const, or anything else, make sure it isn't already in the '__new hunk__' code.
|
- Avoid making suggestions that have already been implemented in the PR code. For example, if you want to add logs, or change a variable to const, or anything else, make sure it isn't already in the '__new hunk__' code.
|
||||||
- Provide the exact line numbers range (inclusive) for each suggestion.
|
- Provide the exact line numbers range (inclusive) for each suggestion.
|
||||||
|
- Assume there is additional relevant code, that is not included in the diff.
|
||||||
- When quoting variables or names from the code, use backticks (`) instead of single quote (').
|
- When quoting variables or names from the code, use backticks (`) instead of single quote (').
|
||||||
|
|
||||||
|
|
||||||
@ -46,22 +49,15 @@ Extra instructions from the user:
|
|||||||
======
|
======
|
||||||
{%- endif %}
|
{%- endif %}
|
||||||
|
|
||||||
The output must be a YAML object equivalent to type $PRCodeSuggestions, according to the following Pydantic definitions:
|
The output must be a YAML object equivalent to type PRCodeSuggestions, according to the following Pydantic definitions:
|
||||||
=====
|
=====
|
||||||
class CodeSuggestion(BaseModel):
|
class CodeSuggestion(BaseModel):
|
||||||
relevant_file: str = Field(description="the relevant file full path")
|
relevant_file: str = Field(description="the relevant file full path")
|
||||||
language: str = Field(description="the code language of the relevant file")
|
|
||||||
suggestion_content: str = Field(description="an actionable suggestion for meaningfully improving the new code introduced in the PR")
|
suggestion_content: str = Field(description="an actionable suggestion for meaningfully improving the new code introduced in the PR")
|
||||||
{%- if summarize_mode %}
|
existing_code: str = Field(description="a code snippet, showing the relevant code lines from a '__new hunk__' section. It must be contiguous, correctly formatted and indented, and without line numbers")
|
||||||
existing_code: str = Field(description="a short code snippet from a '__new hunk__' section to illustrate the relevant existing code. Don't show the line numbers.")
|
|
||||||
improved_code: str = Field(description="a short code snippet to illustrate the improved code, after applying the suggestion.")
|
|
||||||
one_sentence_summary:str = Field(description="a short summary of the suggestion action, in a single sentence. Focus on the 'what'. Be general, and avoid method or variable names.")
|
|
||||||
{%- else %}
|
|
||||||
existing_code: str = Field(description="a code snippet, demonstrating the relevant code lines from a '__new hunk__' section. It must be contiguous, correctly formatted and indented, and without line numbers")
|
|
||||||
improved_code: str = Field(description="a new code snippet, that can be used to replace the relevant lines in '__new hunk__' code. Replacement suggestions should be complete, correctly formatted and indented, and without line numbers")
|
|
||||||
{%- endif %}
|
|
||||||
relevant_lines_start: int = Field(description="The relevant line number, from a '__new hunk__' section, where the suggestion starts (inclusive). Should be derived from the hunk line numbers, and correspond to the 'existing code' snippet above")
|
relevant_lines_start: int = Field(description="The relevant line number, from a '__new hunk__' section, where the suggestion starts (inclusive). Should be derived from the hunk line numbers, and correspond to the 'existing code' snippet above")
|
||||||
relevant_lines_end: int = Field(description="The relevant line number, from a '__new hunk__' section, where the suggestion ends (inclusive). Should be derived from the hunk line numbers, and correspond to the 'existing code' snippet above")
|
relevant_lines_end: int = Field(description="The relevant line number, from a '__new hunk__' section, where the suggestion ends (inclusive). Should be derived from the hunk line numbers, and correspond to the 'existing code' snippet above")
|
||||||
|
improved_code: str = Field(description="a new code snippet, that can be used to replace the relevant lines in '__new hunk__' code. Replacement suggestions should be complete, correctly formatted and indented, and without line numbers")
|
||||||
label: str = Field(description="a single label for the suggestion, to help the user understand the suggestion type. For example: 'security', 'bug', 'performance', 'enhancement', 'possible issue', 'best practice', 'maintainability', etc. Other labels are also allowed")
|
label: str = Field(description="a single label for the suggestion, to help the user understand the suggestion type. For example: 'security', 'bug', 'performance', 'enhancement', 'possible issue', 'best practice', 'maintainability', etc. Other labels are also allowed")
|
||||||
|
|
||||||
class PRCodeSuggestions(BaseModel):
|
class PRCodeSuggestions(BaseModel):
|
||||||
@ -74,27 +70,14 @@ Example output:
|
|||||||
code_suggestions:
|
code_suggestions:
|
||||||
- relevant_file: |-
|
- relevant_file: |-
|
||||||
src/file1.py
|
src/file1.py
|
||||||
language: |-
|
|
||||||
python
|
|
||||||
suggestion_content: |-
|
suggestion_content: |-
|
||||||
Add a docstring to func1()
|
Add a docstring to func1()
|
||||||
{%- if summarize_mode %}
|
|
||||||
existing_code: |-
|
|
||||||
def func1():
|
|
||||||
improved_code: |-
|
|
||||||
...
|
|
||||||
one_sentence_summary: |-
|
|
||||||
...
|
|
||||||
relevant_lines_start: 12
|
|
||||||
relevant_lines_end: 12
|
|
||||||
{%- else %}
|
|
||||||
existing_code: |-
|
existing_code: |-
|
||||||
def func1():
|
def func1():
|
||||||
relevant_lines_start: 12
|
relevant_lines_start: 12
|
||||||
relevant_lines_end: 12
|
relevant_lines_end: 12
|
||||||
improved_code: |-
|
improved_code: |-
|
||||||
...
|
...
|
||||||
{%- endif %}
|
|
||||||
label: |-
|
label: |-
|
||||||
...
|
...
|
||||||
```
|
```
|
||||||
@ -107,6 +90,21 @@ user="""PR Info:
|
|||||||
|
|
||||||
Title: '{{title}}'
|
Title: '{{title}}'
|
||||||
|
|
||||||
|
Branch: '{{branch}}'
|
||||||
|
|
||||||
|
{%- if description %}
|
||||||
|
|
||||||
|
Description:
|
||||||
|
======
|
||||||
|
{{ description|trim }}
|
||||||
|
======
|
||||||
|
{%- endif %}
|
||||||
|
|
||||||
|
{%- if language %}
|
||||||
|
|
||||||
|
Main PR language: '{{ language }}'
|
||||||
|
{%- endif %}
|
||||||
|
|
||||||
|
|
||||||
The PR Diff:
|
The PR Diff:
|
||||||
======
|
======
|
||||||
|
|||||||
@ -15,7 +15,7 @@ Your task is to provide a full description for the PR content - files walkthroug
|
|||||||
|
|
||||||
Extra instructions from the user:
|
Extra instructions from the user:
|
||||||
=====
|
=====
|
||||||
{{extra_instructions}}
|
{{ extra_instructions }}
|
||||||
=====
|
=====
|
||||||
{% endif %}
|
{% endif %}
|
||||||
|
|
||||||
@ -39,9 +39,7 @@ class PRType(str, Enum):
|
|||||||
|
|
||||||
Class FileDescription(BaseModel):
|
Class FileDescription(BaseModel):
|
||||||
filename: str = Field(description="the relevant file full path")
|
filename: str = Field(description="the relevant file full path")
|
||||||
language: str = Field(description="the relevant file language")
|
changes_summary: str = Field(description="minimal and concise summary of the changes in the relevant file")
|
||||||
changes_summary: str = Field(description="concise summary of the changes in the relevant file, in bullet points (1-4 bullet points).")
|
|
||||||
changes_title: str = Field(description="an informative title for the changes in the files, describing its main theme (5-10 words).")
|
|
||||||
label: str = Field(description="a single semantic label that represents a type of code changes that occurred in the File. Possible values (partial list): 'bug fix', 'tests', 'enhancement', 'documentation', 'error handling', 'configuration changes', 'dependencies', 'formatting', 'miscellaneous', ...")
|
label: str = Field(description="a single semantic label that represents a type of code changes that occurred in the File. Possible values (partial list): 'bug fix', 'tests', 'enhancement', 'documentation', 'error handling', 'configuration changes', 'dependencies', 'formatting', 'miscellaneous', ...")
|
||||||
{%- endif %}
|
{%- endif %}
|
||||||
|
|
||||||
@ -68,12 +66,8 @@ type:
|
|||||||
pr_files:
|
pr_files:
|
||||||
- filename: |
|
- filename: |
|
||||||
...
|
...
|
||||||
language: |
|
|
||||||
...
|
|
||||||
changes_summary: |
|
changes_summary: |
|
||||||
...
|
...
|
||||||
changes_title: |
|
|
||||||
...
|
|
||||||
label: |
|
label: |
|
||||||
...
|
...
|
||||||
...
|
...
|
||||||
@ -107,7 +101,10 @@ Previous description:
|
|||||||
{%- endif %}
|
{%- endif %}
|
||||||
|
|
||||||
Branch: '{{branch}}'
|
Branch: '{{branch}}'
|
||||||
|
{%- if language %}
|
||||||
|
|
||||||
|
Main PR language: '{{ language }}'
|
||||||
|
{%- endif %}
|
||||||
{%- if commit_messages_str %}
|
{%- if commit_messages_str %}
|
||||||
|
|
||||||
Commit messages:
|
Commit messages:
|
||||||
|
|||||||
@ -1,7 +1,7 @@
|
|||||||
[pr_questions_prompt]
|
[pr_questions_prompt]
|
||||||
system="""You are PR-Reviewer, a language model designed to answer questions about a Git Pull Request (PR).
|
system="""You are PR-Reviewer, a language model designed to review a Git Pull Request (PR).
|
||||||
|
|
||||||
Your goal is to answer questions\\tasks about the new code introduced in the PR (lines starting with '+' in the 'PR Git Diff' section), and provide feedback.
|
Your goal is to answer questions\\tasks about the new PR code (lines starting with '+'), and provide feedback.
|
||||||
Be informative, constructive, and give examples. Try to be as specific as possible.
|
Be informative, constructive, and give examples. Try to be as specific as possible.
|
||||||
Don't avoid answering the questions. You must answer the questions, as best as you can, without adding any unrelated content.
|
Don't avoid answering the questions. You must answer the questions, as best as you can, without adding any unrelated content.
|
||||||
"""
|
"""
|
||||||
|
|||||||
@ -5,7 +5,7 @@ The review should focus on new code added in the PR diff (lines starting with '+
|
|||||||
|
|
||||||
Example PR Diff:
|
Example PR Diff:
|
||||||
======
|
======
|
||||||
## file: 'src/file1.py'
|
## src/file1.py
|
||||||
|
|
||||||
@@ -12,5 +12,5 @@ def func1():
|
@@ -12,5 +12,5 @@ def func1():
|
||||||
code line 1 that remained unchanged in the PR
|
code line 1 that remained unchanged in the PR
|
||||||
@ -14,11 +14,12 @@ code line 2 that remained unchanged in the PR
|
|||||||
+code line added in the PR
|
+code line added in the PR
|
||||||
code line 3 that remained unchanged in the PR
|
code line 3 that remained unchanged in the PR
|
||||||
|
|
||||||
|
|
||||||
@@ ... @@ def func2():
|
@@ ... @@ def func2():
|
||||||
...
|
...
|
||||||
|
|
||||||
|
|
||||||
## file: 'src/file2.py'
|
## src/file2.py
|
||||||
...
|
...
|
||||||
======
|
======
|
||||||
|
|
||||||
@ -114,9 +115,6 @@ PR Feedback:
|
|||||||
relevant file:
|
relevant file:
|
||||||
type: string
|
type: string
|
||||||
description: the relevant file full path
|
description: the relevant file full path
|
||||||
language:
|
|
||||||
type: string
|
|
||||||
description: the language of the relevant file
|
|
||||||
suggestion:
|
suggestion:
|
||||||
type: string
|
type: string
|
||||||
description: |-
|
description: |-
|
||||||
@ -168,8 +166,6 @@ PR Feedback:
|
|||||||
Code feedback:
|
Code feedback:
|
||||||
- relevant file: |-
|
- relevant file: |-
|
||||||
directory/xxx.py
|
directory/xxx.py
|
||||||
language: |-
|
|
||||||
python
|
|
||||||
suggestion: |-
|
suggestion: |-
|
||||||
xxx [important]
|
xxx [important]
|
||||||
relevant line: |-
|
relevant line: |-
|
||||||
@ -199,6 +195,10 @@ Description:
|
|||||||
======
|
======
|
||||||
{%- endif %}
|
{%- endif %}
|
||||||
|
|
||||||
|
{%- if language %}
|
||||||
|
|
||||||
|
Main PR language: '{{ language }}'
|
||||||
|
{%- endif %}
|
||||||
{%- if commit_messages_str %}
|
{%- if commit_messages_str %}
|
||||||
|
|
||||||
Commit messages:
|
Commit messages:
|
||||||
|
|||||||
@ -8,14 +8,12 @@ from pr_agent.algo.ai_handlers.base_ai_handler import BaseAiHandler
|
|||||||
from pr_agent.algo.ai_handlers.litellm_ai_handler import LiteLLMAIHandler
|
from pr_agent.algo.ai_handlers.litellm_ai_handler import LiteLLMAIHandler
|
||||||
from pr_agent.algo.pr_processing import get_pr_diff, get_pr_multi_diffs, retry_with_fallback_models
|
from pr_agent.algo.pr_processing import get_pr_diff, get_pr_multi_diffs, retry_with_fallback_models
|
||||||
from pr_agent.algo.token_handler import TokenHandler
|
from pr_agent.algo.token_handler import TokenHandler
|
||||||
from pr_agent.algo.utils import load_yaml, replace_code_tags
|
from pr_agent.algo.utils import load_yaml
|
||||||
from pr_agent.config_loader import get_settings
|
from pr_agent.config_loader import get_settings
|
||||||
from pr_agent.git_providers import get_git_provider
|
from pr_agent.git_providers import get_git_provider
|
||||||
from pr_agent.git_providers.git_provider import get_main_pr_language
|
from pr_agent.git_providers.git_provider import get_main_pr_language
|
||||||
from pr_agent.log import get_logger
|
from pr_agent.log import get_logger
|
||||||
from pr_agent.servers.help import HelpMessage
|
|
||||||
from pr_agent.tools.pr_description import insert_br_after_x_chars
|
|
||||||
import difflib
|
|
||||||
|
|
||||||
class PRCodeSuggestions:
|
class PRCodeSuggestions:
|
||||||
def __init__(self, pr_url: str, cli_mode=False, args: list = None,
|
def __init__(self, pr_url: str, cli_mode=False, args: list = None,
|
||||||
@ -47,7 +45,6 @@ class PRCodeSuggestions:
|
|||||||
"language": self.main_language,
|
"language": self.main_language,
|
||||||
"diff": "", # empty diff for initial calculation
|
"diff": "", # empty diff for initial calculation
|
||||||
"num_code_suggestions": num_code_suggestions,
|
"num_code_suggestions": num_code_suggestions,
|
||||||
"summarize_mode": get_settings().pr_code_suggestions.summarize,
|
|
||||||
"extra_instructions": get_settings().pr_code_suggestions.extra_instructions,
|
"extra_instructions": get_settings().pr_code_suggestions.extra_instructions,
|
||||||
"commit_messages_str": self.git_provider.get_commit_messages(),
|
"commit_messages_str": self.git_provider.get_commit_messages(),
|
||||||
}
|
}
|
||||||
@ -68,8 +65,6 @@ class PRCodeSuggestions:
|
|||||||
data = self._prepare_pr_code_suggestions()
|
data = self._prepare_pr_code_suggestions()
|
||||||
else:
|
else:
|
||||||
data = await retry_with_fallback_models(self._prepare_prediction_extended)
|
data = await retry_with_fallback_models(self._prepare_prediction_extended)
|
||||||
|
|
||||||
|
|
||||||
if (not data) or (not 'code_suggestions' in data):
|
if (not data) or (not 'code_suggestions' in data):
|
||||||
get_logger().info('No code suggestions found for PR.')
|
get_logger().info('No code suggestions found for PR.')
|
||||||
return
|
return
|
||||||
@ -82,19 +77,9 @@ class PRCodeSuggestions:
|
|||||||
if get_settings().config.publish_output:
|
if get_settings().config.publish_output:
|
||||||
get_logger().info('Pushing PR code suggestions...')
|
get_logger().info('Pushing PR code suggestions...')
|
||||||
self.git_provider.remove_initial_comment()
|
self.git_provider.remove_initial_comment()
|
||||||
if get_settings().pr_code_suggestions.summarize and self.git_provider.is_supported("gfm_markdown"):
|
if get_settings().pr_code_suggestions.summarize:
|
||||||
get_logger().info('Pushing summarize code suggestions...')
|
get_logger().info('Pushing summarize code suggestions...')
|
||||||
|
self.publish_summarizes_suggestions(data)
|
||||||
# generate summarized suggestions
|
|
||||||
pr_body = self.generate_summarized_suggestions(data)
|
|
||||||
|
|
||||||
# add usage guide
|
|
||||||
if get_settings().pr_code_suggestions.enable_help_text:
|
|
||||||
pr_body += "<hr>\n\n<details> <summary><strong>✨ Usage guide:</strong></summary><hr> \n\n"
|
|
||||||
pr_body += HelpMessage.get_improve_usage_guide()
|
|
||||||
pr_body += "\n</details>\n"
|
|
||||||
|
|
||||||
self.git_provider.publish_comment(pr_body)
|
|
||||||
else:
|
else:
|
||||||
get_logger().info('Pushing inline code suggestions...')
|
get_logger().info('Pushing inline code suggestions...')
|
||||||
self.push_inline_code_suggestions(data)
|
self.push_inline_code_suggestions(data)
|
||||||
@ -169,19 +154,35 @@ class PRCodeSuggestions:
|
|||||||
if new_code_snippet:
|
if new_code_snippet:
|
||||||
new_code_snippet = self.dedent_code(relevant_file, relevant_lines_start, new_code_snippet)
|
new_code_snippet = self.dedent_code(relevant_file, relevant_lines_start, new_code_snippet)
|
||||||
|
|
||||||
|
if get_settings().pr_code_suggestions.include_improved_code:
|
||||||
body = f"**Suggestion:** {content} [{label}]\n```suggestion\n" + new_code_snippet + "\n```"
|
body = f"**Suggestion:** {content} [{label}]\n```suggestion\n" + new_code_snippet + "\n```"
|
||||||
code_suggestions.append({'body': body, 'relevant_file': relevant_file,
|
code_suggestions.append({'body': body, 'relevant_file': relevant_file,
|
||||||
'relevant_lines_start': relevant_lines_start,
|
'relevant_lines_start': relevant_lines_start,
|
||||||
'relevant_lines_end': relevant_lines_end})
|
'relevant_lines_end': relevant_lines_end})
|
||||||
|
else:
|
||||||
|
if self.git_provider.is_supported("create_inline_comment"):
|
||||||
|
body = f"**Suggestion:** {content} [{label}]"
|
||||||
|
comment = self.git_provider.create_inline_comment(body, relevant_file, "",
|
||||||
|
absolute_position=relevant_lines_end)
|
||||||
|
if comment:
|
||||||
|
code_suggestions.append(comment)
|
||||||
|
else:
|
||||||
|
get_logger().error("Inline comments are not supported by the git provider")
|
||||||
except Exception:
|
except Exception:
|
||||||
if get_settings().config.verbosity_level >= 2:
|
if get_settings().config.verbosity_level >= 2:
|
||||||
get_logger().info(f"Could not parse suggestion: {d}")
|
get_logger().info(f"Could not parse suggestion: {d}")
|
||||||
|
|
||||||
|
if get_settings().pr_code_suggestions.include_improved_code:
|
||||||
is_successful = self.git_provider.publish_code_suggestions(code_suggestions)
|
is_successful = self.git_provider.publish_code_suggestions(code_suggestions)
|
||||||
|
else:
|
||||||
|
is_successful = self.git_provider.publish_inline_comments(code_suggestions)
|
||||||
if not is_successful:
|
if not is_successful:
|
||||||
get_logger().info("Failed to publish code suggestions, trying to publish each suggestion separately")
|
get_logger().info("Failed to publish code suggestions, trying to publish each suggestion separately")
|
||||||
for code_suggestion in code_suggestions:
|
for code_suggestion in code_suggestions:
|
||||||
|
if get_settings().pr_code_suggestions.include_improved_code:
|
||||||
self.git_provider.publish_code_suggestions([code_suggestion])
|
self.git_provider.publish_code_suggestions([code_suggestion])
|
||||||
|
else:
|
||||||
|
self.git_provider.publish_inline_comments([code_suggestion])
|
||||||
|
|
||||||
def dedent_code(self, relevant_file, relevant_lines_start, new_code_snippet):
|
def dedent_code(self, relevant_file, relevant_lines_start, new_code_snippet):
|
||||||
try: # dedent code snippet
|
try: # dedent code snippet
|
||||||
@ -190,7 +191,6 @@ class PRCodeSuggestions:
|
|||||||
original_initial_line = None
|
original_initial_line = None
|
||||||
for file in self.diff_files:
|
for file in self.diff_files:
|
||||||
if file.filename.strip() == relevant_file:
|
if file.filename.strip() == relevant_file:
|
||||||
if file.head_file: # in bitbucket, head_file is empty. toDo: fix this
|
|
||||||
original_initial_line = file.head_file.splitlines()[relevant_lines_start - 1]
|
original_initial_line = file.head_file.splitlines()[relevant_lines_start - 1]
|
||||||
break
|
break
|
||||||
if original_initial_line:
|
if original_initial_line:
|
||||||
@ -226,7 +226,7 @@ class PRCodeSuggestions:
|
|||||||
for i, patches_diff in enumerate(patches_diff_list):
|
for i, patches_diff in enumerate(patches_diff_list):
|
||||||
get_logger().info(f"Processing chunk {i + 1} of {len(patches_diff_list)}")
|
get_logger().info(f"Processing chunk {i + 1} of {len(patches_diff_list)}")
|
||||||
self.patches_diff = patches_diff
|
self.patches_diff = patches_diff
|
||||||
prediction = await self._get_prediction(model) # toDo: parallelize
|
prediction = await self._get_prediction(model)
|
||||||
prediction_list.append(prediction)
|
prediction_list.append(prediction)
|
||||||
self.prediction_list = prediction_list
|
self.prediction_list = prediction_list
|
||||||
|
|
||||||
@ -253,15 +253,10 @@ class PRCodeSuggestions:
|
|||||||
"""
|
"""
|
||||||
|
|
||||||
suggestion_list = []
|
suggestion_list = []
|
||||||
if not data:
|
|
||||||
return suggestion_list
|
|
||||||
for suggestion in data:
|
for suggestion in data:
|
||||||
suggestion_list.append(suggestion)
|
suggestion_list.append(suggestion)
|
||||||
data_sorted = [[]] * len(suggestion_list)
|
data_sorted = [[]] * len(suggestion_list)
|
||||||
|
|
||||||
if len(suggestion_list ) == 1:
|
|
||||||
return suggestion_list
|
|
||||||
|
|
||||||
try:
|
try:
|
||||||
suggestion_str = ""
|
suggestion_str = ""
|
||||||
for i, suggestion in enumerate(suggestion_list):
|
for i, suggestion in enumerate(suggestion_list):
|
||||||
@ -301,13 +296,9 @@ class PRCodeSuggestions:
|
|||||||
|
|
||||||
return data_sorted
|
return data_sorted
|
||||||
|
|
||||||
def generate_summarized_suggestions(self, data: Dict) -> str:
|
def publish_summarizes_suggestions(self, data: Dict):
|
||||||
try:
|
try:
|
||||||
pr_body = "## PR Code Suggestions\n\n"
|
data_markdown = "## PR Code Suggestions\n\n"
|
||||||
|
|
||||||
if len(data.get('code_suggestions', [])) == 0:
|
|
||||||
pr_body += "No suggestions found to improve this PR."
|
|
||||||
return pr_body
|
|
||||||
|
|
||||||
language_extension_map_org = get_settings().language_extension_map_org
|
language_extension_map_org = get_settings().language_extension_map_org
|
||||||
extension_to_language = {}
|
extension_to_language = {}
|
||||||
@ -315,78 +306,30 @@ class PRCodeSuggestions:
|
|||||||
for ext in extensions:
|
for ext in extensions:
|
||||||
extension_to_language[ext] = language
|
extension_to_language[ext] = language
|
||||||
|
|
||||||
pr_body += "<table>"
|
for s in data['code_suggestions']:
|
||||||
header = f"Suggestions"
|
try:
|
||||||
delta = 77
|
extension_s = s['relevant_file'].rsplit('.')[-1]
|
||||||
header += " " * delta
|
code_snippet_link = self.git_provider.get_line_link(s['relevant_file'], s['relevant_lines_start'],
|
||||||
pr_body += f"""<thead><tr><th></th><th>{header}</th></tr></thead>"""
|
s['relevant_lines_end'])
|
||||||
pr_body += """<tbody>"""
|
label = s['label'].strip()
|
||||||
suggestions_labels = dict()
|
data_markdown += f"\n💡 [{label}]\n\n**{s['suggestion_content'].rstrip().rstrip()}**\n\n"
|
||||||
# add all suggestions related to each label
|
if code_snippet_link:
|
||||||
for suggestion in data['code_suggestions']:
|
data_markdown += f" File: [{s['relevant_file']} ({s['relevant_lines_start']}-{s['relevant_lines_end']})]({code_snippet_link})\n\n"
|
||||||
label = suggestion['label'].strip().strip("'").strip('"')
|
|
||||||
if label not in suggestions_labels:
|
|
||||||
suggestions_labels[label] = []
|
|
||||||
suggestions_labels[label].append(suggestion)
|
|
||||||
|
|
||||||
for label, suggestions in suggestions_labels.items():
|
|
||||||
pr_body += f"""<tr><td><strong>{label}</strong></td>"""
|
|
||||||
pr_body += f"""<td>"""
|
|
||||||
# pr_body += f"""<details><summary>{len(suggestions)} suggestions</summary>"""
|
|
||||||
pr_body += f"""<table>"""
|
|
||||||
for suggestion in suggestions:
|
|
||||||
|
|
||||||
relevant_file = suggestion['relevant_file'].strip()
|
|
||||||
relevant_lines_start = int(suggestion['relevant_lines_start'])
|
|
||||||
relevant_lines_end = int(suggestion['relevant_lines_end'])
|
|
||||||
range_str = ""
|
|
||||||
if relevant_lines_start == relevant_lines_end:
|
|
||||||
range_str = f"[{relevant_lines_start}]"
|
|
||||||
else:
|
else:
|
||||||
range_str = f"[{relevant_lines_start}-{relevant_lines_end}]"
|
data_markdown += f"File: {s['relevant_file']} ({s['relevant_lines_start']}-{s['relevant_lines_end']})\n\n"
|
||||||
code_snippet_link = self.git_provider.get_line_link(relevant_file, relevant_lines_start,
|
if self.git_provider.is_supported("gfm_markdown"):
|
||||||
relevant_lines_end)
|
data_markdown += "<details> <summary> Example code:</summary>\n\n"
|
||||||
# add html table for each suggestion
|
data_markdown += f"___\n\n"
|
||||||
|
language_name = "python"
|
||||||
suggestion_content = suggestion['suggestion_content'].rstrip().rstrip()
|
if extension_s and (extension_s in extension_to_language):
|
||||||
|
language_name = extension_to_language[extension_s]
|
||||||
suggestion_content = insert_br_after_x_chars(suggestion_content, 90)
|
data_markdown += f"Existing code:\n```{language_name}\n{s['existing_code'].rstrip()}\n```\n"
|
||||||
# pr_body += f"<tr><td><details><summary>{suggestion_content}</summary>"
|
data_markdown += f"Improved code:\n```{language_name}\n{s['improved_code'].rstrip()}\n```\n"
|
||||||
existing_code = suggestion['existing_code'].rstrip()+"\n"
|
if self.git_provider.is_supported("gfm_markdown"):
|
||||||
improved_code = suggestion['improved_code'].rstrip()+"\n"
|
data_markdown += "</details>\n"
|
||||||
|
data_markdown += "\n___\n\n"
|
||||||
diff = difflib.unified_diff(existing_code.split('\n'),
|
except Exception as e:
|
||||||
improved_code.split('\n'), n=999)
|
get_logger().error(f"Could not parse suggestion: {s}, error: {e}")
|
||||||
patch_orig = "\n".join(diff)
|
self.git_provider.publish_comment(data_markdown)
|
||||||
patch = "\n".join(patch_orig.splitlines()[5:]).strip('\n')
|
|
||||||
|
|
||||||
example_code = ""
|
|
||||||
example_code += f"```diff\n{patch}\n```\n"
|
|
||||||
|
|
||||||
pr_body += f"""<tr><td>"""
|
|
||||||
suggestion_summary = suggestion['one_sentence_summary'].strip()
|
|
||||||
if '`' in suggestion_summary:
|
|
||||||
suggestion_summary = replace_code_tags(suggestion_summary)
|
|
||||||
suggestion_summary = suggestion_summary + max((77-len(suggestion_summary)), 0)*" "
|
|
||||||
pr_body += f"""\n\n<details><summary>{suggestion_summary}</summary>\n\n___\n\n"""
|
|
||||||
|
|
||||||
pr_body += f"""
|
|
||||||
|
|
||||||
|
|
||||||
**{suggestion_content}**
|
|
||||||
|
|
||||||
[{relevant_file} {range_str}]({code_snippet_link})
|
|
||||||
|
|
||||||
{example_code}
|
|
||||||
"""
|
|
||||||
pr_body += f"</details>"
|
|
||||||
pr_body += f"</td></tr>"
|
|
||||||
|
|
||||||
pr_body += """</table>"""
|
|
||||||
# pr_body += "</details>"
|
|
||||||
pr_body += """</td></tr>"""
|
|
||||||
pr_body += """</tr></tbody></table>"""
|
|
||||||
return pr_body
|
|
||||||
except Exception as e:
|
except Exception as e:
|
||||||
get_logger().info(f"Failed to publish summarized code suggestions, error: {e}")
|
get_logger().info(f"Failed to publish summarized code suggestions, error: {e}")
|
||||||
return ""
|
|
||||||
|
|||||||
@ -14,7 +14,6 @@ from pr_agent.config_loader import get_settings
|
|||||||
from pr_agent.git_providers import get_git_provider
|
from pr_agent.git_providers import get_git_provider
|
||||||
from pr_agent.git_providers.git_provider import get_main_pr_language
|
from pr_agent.git_providers.git_provider import get_main_pr_language
|
||||||
from pr_agent.log import get_logger
|
from pr_agent.log import get_logger
|
||||||
from pr_agent.servers.help import HelpMessage
|
|
||||||
|
|
||||||
|
|
||||||
class PRDescription:
|
class PRDescription:
|
||||||
@ -86,7 +85,6 @@ class PRDescription:
|
|||||||
if self.prediction:
|
if self.prediction:
|
||||||
self._prepare_data()
|
self._prepare_data()
|
||||||
else:
|
else:
|
||||||
self.git_provider.remove_initial_comment()
|
|
||||||
return None
|
return None
|
||||||
|
|
||||||
if get_settings().pr_description.enable_semantic_files_types:
|
if get_settings().pr_description.enable_semantic_files_types:
|
||||||
@ -100,34 +98,20 @@ class PRDescription:
|
|||||||
pr_title, pr_body = self._prepare_pr_answer_with_markers()
|
pr_title, pr_body = self._prepare_pr_answer_with_markers()
|
||||||
else:
|
else:
|
||||||
pr_title, pr_body, = self._prepare_pr_answer()
|
pr_title, pr_body, = self._prepare_pr_answer()
|
||||||
|
|
||||||
# Add help text if gfm_markdown is supported
|
|
||||||
if self.git_provider.is_supported("gfm_markdown") and get_settings().pr_description.enable_help_text:
|
|
||||||
pr_body += "<hr>\n\n<details> <summary><strong>✨ Usage guide:</strong></summary><hr> \n\n"
|
|
||||||
pr_body += HelpMessage.get_describe_usage_guide()
|
|
||||||
pr_body += "\n</details>\n"
|
|
||||||
|
|
||||||
# final markdown description
|
|
||||||
full_markdown_description = f"## Title\n\n{pr_title}\n\n___\n{pr_body}"
|
full_markdown_description = f"## Title\n\n{pr_title}\n\n___\n{pr_body}"
|
||||||
get_logger().debug(f"full_markdown_description:\n{full_markdown_description}")
|
|
||||||
|
|
||||||
if get_settings().config.publish_output:
|
if get_settings().config.publish_output:
|
||||||
get_logger().info(f"Pushing answer {self.pr_id}")
|
get_logger().info(f"Pushing answer {self.pr_id}")
|
||||||
|
|
||||||
# publish labels
|
|
||||||
if get_settings().pr_description.publish_labels and self.git_provider.is_supported("get_labels"):
|
|
||||||
current_labels = self.git_provider.get_pr_labels()
|
|
||||||
user_labels = get_user_labels(current_labels)
|
|
||||||
self.git_provider.publish_labels(pr_labels + user_labels)
|
|
||||||
|
|
||||||
# publish description
|
|
||||||
if get_settings().pr_description.publish_description_as_comment:
|
if get_settings().pr_description.publish_description_as_comment:
|
||||||
get_logger().info(f"Publishing answer as comment")
|
get_logger().info(f"Publishing answer as comment")
|
||||||
self.git_provider.publish_comment(full_markdown_description)
|
self.git_provider.publish_comment(full_markdown_description)
|
||||||
else:
|
else:
|
||||||
self.git_provider.publish_description(pr_title, pr_body)
|
self.git_provider.publish_description(pr_title, pr_body)
|
||||||
|
if get_settings().pr_description.publish_labels and self.git_provider.is_supported("get_labels"):
|
||||||
|
current_labels = self.git_provider.get_pr_labels()
|
||||||
|
user_labels = get_user_labels(current_labels)
|
||||||
|
self.git_provider.publish_labels(pr_labels + user_labels)
|
||||||
|
|
||||||
# publish final update message
|
|
||||||
if (get_settings().pr_description.final_update_message and
|
if (get_settings().pr_description.final_update_message and
|
||||||
hasattr(self.git_provider, 'pr_url') and self.git_provider.pr_url):
|
hasattr(self.git_provider, 'pr_url') and self.git_provider.pr_url):
|
||||||
latest_commit_url = self.git_provider.get_latest_commit_url()
|
latest_commit_url = self.git_provider.get_latest_commit_url()
|
||||||
@ -141,17 +125,26 @@ class PRDescription:
|
|||||||
return ""
|
return ""
|
||||||
|
|
||||||
async def _prepare_prediction(self, model: str) -> None:
|
async def _prepare_prediction(self, model: str) -> None:
|
||||||
|
"""
|
||||||
|
Prepare the AI prediction for the PR description based on the provided model.
|
||||||
|
|
||||||
|
Args:
|
||||||
|
model (str): The name of the model to be used for generating the prediction.
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
None
|
||||||
|
|
||||||
|
Raises:
|
||||||
|
Any exceptions raised by the 'get_pr_diff' and '_get_prediction' functions.
|
||||||
|
|
||||||
|
"""
|
||||||
if get_settings().pr_description.use_description_markers and 'pr_agent:' not in self.user_description:
|
if get_settings().pr_description.use_description_markers and 'pr_agent:' not in self.user_description:
|
||||||
return None
|
return None
|
||||||
|
|
||||||
get_logger().info(f"Getting PR diff {self.pr_id}")
|
get_logger().info(f"Getting PR diff {self.pr_id}")
|
||||||
self.patches_diff = get_pr_diff(self.git_provider, self.token_handler, model)
|
self.patches_diff = get_pr_diff(self.git_provider, self.token_handler, model)
|
||||||
if self.patches_diff:
|
|
||||||
get_logger().info(f"Getting AI prediction {self.pr_id}")
|
get_logger().info(f"Getting AI prediction {self.pr_id}")
|
||||||
self.prediction = await self._get_prediction(model)
|
self.prediction = await self._get_prediction(model)
|
||||||
else:
|
|
||||||
get_logger().error(f"Error getting PR diff {self.pr_id}")
|
|
||||||
self.prediction = None
|
|
||||||
|
|
||||||
async def _get_prediction(self, model: str) -> str:
|
async def _get_prediction(self, model: str) -> str:
|
||||||
"""
|
"""
|
||||||
@ -286,7 +279,7 @@ class PRDescription:
|
|||||||
if not get_settings().pr_description.enable_pr_type:
|
if not get_settings().pr_description.enable_pr_type:
|
||||||
self.data.pop('type')
|
self.data.pop('type')
|
||||||
for key, value in self.data.items():
|
for key, value in self.data.items():
|
||||||
markdown_text += f"## **{key}**\n\n"
|
markdown_text += f"## {key}\n\n"
|
||||||
markdown_text += f"{value}\n\n"
|
markdown_text += f"{value}\n\n"
|
||||||
|
|
||||||
# Remove the 'PR Title' key from the dictionary
|
# Remove the 'PR Title' key from the dictionary
|
||||||
@ -307,7 +300,7 @@ class PRDescription:
|
|||||||
key_publish = "Changes walkthrough"
|
key_publish = "Changes walkthrough"
|
||||||
else:
|
else:
|
||||||
key_publish = key.rstrip(':').replace("_", " ").capitalize()
|
key_publish = key.rstrip(':').replace("_", " ").capitalize()
|
||||||
pr_body += f"## **{key_publish}**\n"
|
pr_body += f"## {key_publish}\n"
|
||||||
if 'walkthrough' in key.lower():
|
if 'walkthrough' in key.lower():
|
||||||
if self.git_provider.is_supported("gfm_markdown"):
|
if self.git_provider.is_supported("gfm_markdown"):
|
||||||
pr_body += "<details> <summary>files:</summary>\n\n"
|
pr_body += "<details> <summary>files:</summary>\n\n"
|
||||||
@ -338,11 +331,10 @@ class PRDescription:
|
|||||||
try:
|
try:
|
||||||
filename = file['filename'].replace("'", "`").replace('"', '`')
|
filename = file['filename'].replace("'", "`").replace('"', '`')
|
||||||
changes_summary = file['changes_summary']
|
changes_summary = file['changes_summary']
|
||||||
changes_title = file['changes_title'].strip()
|
|
||||||
label = file.get('label')
|
label = file.get('label')
|
||||||
if label not in self.file_label_dict:
|
if label not in self.file_label_dict:
|
||||||
self.file_label_dict[label] = []
|
self.file_label_dict[label] = []
|
||||||
self.file_label_dict[label].append((filename, changes_title, changes_summary))
|
self.file_label_dict[label].append((filename, changes_summary))
|
||||||
except Exception as e:
|
except Exception as e:
|
||||||
get_logger().error(f"Error preparing file label dict {self.pr_id}: {e}")
|
get_logger().error(f"Error preparing file label dict {self.pr_id}: {e}")
|
||||||
pass
|
pass
|
||||||
@ -363,9 +355,9 @@ class PRDescription:
|
|||||||
try:
|
try:
|
||||||
pr_body += "<table>"
|
pr_body += "<table>"
|
||||||
header = f"Relevant files"
|
header = f"Relevant files"
|
||||||
delta = 77
|
delta = 65
|
||||||
# header += " " * delta
|
header += " " * delta
|
||||||
pr_body += f"""<thead><tr><th></th><th align="left">{header}</th></tr></thead>"""
|
pr_body += f"""<thead><tr><th></th><th>{header}</th></tr></thead>"""
|
||||||
pr_body += """<tbody>"""
|
pr_body += """<tbody>"""
|
||||||
for semantic_label in value.keys():
|
for semantic_label in value.keys():
|
||||||
s_label = semantic_label.strip("'").strip('"')
|
s_label = semantic_label.strip("'").strip('"')
|
||||||
@ -376,24 +368,19 @@ class PRDescription:
|
|||||||
pr_body += f"""<td><details><summary>{len(list_tuples)} files</summary><table>"""
|
pr_body += f"""<td><details><summary>{len(list_tuples)} files</summary><table>"""
|
||||||
else:
|
else:
|
||||||
pr_body += f"""<td><table>"""
|
pr_body += f"""<td><table>"""
|
||||||
for filename, file_changes_title, file_change_description in list_tuples:
|
for filename, file_change_description in list_tuples:
|
||||||
filename = filename.replace("'", "`")
|
filename = filename.replace("'", "`")
|
||||||
filename_publish = filename.split("/")[-1]
|
filename_publish = filename.split("/")[-1]
|
||||||
file_changes_title_br = insert_br_after_x_chars(file_changes_title, x=(delta - 5),
|
filename_publish = f"{filename_publish}"
|
||||||
new_line_char="\n\n")
|
if len(filename_publish) < (delta - 5):
|
||||||
file_changes_title_extended = file_changes_title_br.strip() + "</code>"
|
filename_publish += " " * ((delta - 5) - len(filename_publish))
|
||||||
if len(file_changes_title_extended) < (delta - 5):
|
|
||||||
file_changes_title_extended += " " * ((delta - 5) - len(file_changes_title_extended))
|
|
||||||
filename_publish = f"<strong>{filename_publish}</strong><dd><code>{file_changes_title_extended}</dd>"
|
|
||||||
diff_plus_minus = ""
|
diff_plus_minus = ""
|
||||||
delta_nbsp = ""
|
|
||||||
diff_files = self.git_provider.diff_files
|
diff_files = self.git_provider.diff_files
|
||||||
for f in diff_files:
|
for f in diff_files:
|
||||||
if f.filename.lower() == filename.lower():
|
if f.filename.lower() == filename.lower():
|
||||||
num_plus_lines = f.num_plus_lines
|
num_plus_lines = f.num_plus_lines
|
||||||
num_minus_lines = f.num_minus_lines
|
num_minus_lines = f.num_minus_lines
|
||||||
diff_plus_minus += f"+{num_plus_lines}/-{num_minus_lines}"
|
diff_plus_minus += f"+{num_plus_lines}/-{num_minus_lines}"
|
||||||
delta_nbsp = " " * max(0, (8 - len(diff_plus_minus)))
|
|
||||||
break
|
break
|
||||||
|
|
||||||
# try to add line numbers link to code suggestions
|
# try to add line numbers link to code suggestions
|
||||||
@ -402,19 +389,21 @@ class PRDescription:
|
|||||||
filename = filename.strip()
|
filename = filename.strip()
|
||||||
link = self.git_provider.get_line_link(filename, relevant_line_start=-1)
|
link = self.git_provider.get_line_link(filename, relevant_line_start=-1)
|
||||||
|
|
||||||
file_change_description_br = insert_br_after_x_chars(file_change_description, x=(delta - 5))
|
file_change_description = self._insert_br_after_x_chars(file_change_description, x=(delta - 5))
|
||||||
pr_body += f"""
|
pr_body += f"""
|
||||||
<tr>
|
<tr>
|
||||||
<td>
|
<td>
|
||||||
<details>
|
<details>
|
||||||
<summary>{filename_publish}</summary>
|
<summary><strong>{filename_publish}</strong></summary>
|
||||||
<hr>
|
<ul>
|
||||||
|
{filename}<br><br>
|
||||||
|
|
||||||
{filename}
|
**{file_change_description}**
|
||||||
{file_change_description_br}
|
</ul>
|
||||||
</details>
|
</details>
|
||||||
</td>
|
</td>
|
||||||
<td><a href="{link}">{diff_plus_minus}</a>{delta_nbsp}</td>
|
<td><a href="{link}"> {diff_plus_minus}</a></td>
|
||||||
|
|
||||||
</tr>
|
</tr>
|
||||||
"""
|
"""
|
||||||
if use_collapsible_file_list:
|
if use_collapsible_file_list:
|
||||||
@ -428,48 +417,25 @@ class PRDescription:
|
|||||||
pass
|
pass
|
||||||
return pr_body
|
return pr_body
|
||||||
|
|
||||||
def insert_br_after_x_chars(text, x=70, new_line_char="<br> "):
|
def _insert_br_after_x_chars(self, text, x=70):
|
||||||
"""
|
"""
|
||||||
Insert <br> into a string after a word that increases its length above x characters.
|
Insert <br> into a string after a word that increases its length above x characters.
|
||||||
"""
|
"""
|
||||||
if len(text) < x:
|
if len(text) < x:
|
||||||
return text
|
return text
|
||||||
|
|
||||||
lines = text.splitlines()
|
words = text.split(' ')
|
||||||
words = []
|
|
||||||
for i,line in enumerate(lines):
|
|
||||||
words += line.split(' ')
|
|
||||||
if i<len(lines)-1:
|
|
||||||
words[-1] += "\n"
|
|
||||||
|
|
||||||
|
|
||||||
# words = text.split(' ')
|
|
||||||
|
|
||||||
new_text = ""
|
new_text = ""
|
||||||
current_length = 0
|
current_length = 0
|
||||||
is_inside_code = False
|
|
||||||
for word in words:
|
for word in words:
|
||||||
# Check if adding this word exceeds x characters
|
# Check if adding this word exceeds x characters
|
||||||
if current_length + len(word) > x:
|
if current_length + len(word) > x:
|
||||||
if not is_inside_code:
|
new_text += "<br>" # Insert line break
|
||||||
new_text += f"{new_line_char} " # Insert line break
|
|
||||||
current_length = 0 # Reset counter
|
current_length = 0 # Reset counter
|
||||||
else:
|
|
||||||
new_text += f"`{new_line_char} `"
|
|
||||||
# check if inside <code> tag
|
|
||||||
if word.startswith("`") and not is_inside_code and not word.endswith("`"):
|
|
||||||
is_inside_code = True
|
|
||||||
if word.endswith("`"):
|
|
||||||
is_inside_code = False
|
|
||||||
|
|
||||||
# Add the word to the new text
|
# Add the word to the new text
|
||||||
if word.endswith("\n"):
|
|
||||||
new_text += word
|
|
||||||
else:
|
|
||||||
new_text += word + " "
|
new_text += word + " "
|
||||||
current_length += len(word) + 1 # Add 1 for the space
|
current_length += len(word) + 1 # Add 1 for the space
|
||||||
|
|
||||||
|
|
||||||
if word.endswith("\n"):
|
|
||||||
current_length = 0
|
|
||||||
return new_text.strip() # Remove trailing space
|
return new_text.strip() # Remove trailing space
|
||||||
|
|||||||
@ -11,7 +11,6 @@ from pr_agent.config_loader import get_settings
|
|||||||
from pr_agent.git_providers import get_git_provider
|
from pr_agent.git_providers import get_git_provider
|
||||||
from pr_agent.git_providers.git_provider import get_main_pr_language
|
from pr_agent.git_providers.git_provider import get_main_pr_language
|
||||||
from pr_agent.log import get_logger
|
from pr_agent.log import get_logger
|
||||||
from pr_agent.servers.help import HelpMessage
|
|
||||||
|
|
||||||
|
|
||||||
class PRQuestions:
|
class PRQuestions:
|
||||||
@ -53,11 +52,6 @@ class PRQuestions:
|
|||||||
await retry_with_fallback_models(self._prepare_prediction)
|
await retry_with_fallback_models(self._prepare_prediction)
|
||||||
get_logger().info('Preparing answer...')
|
get_logger().info('Preparing answer...')
|
||||||
pr_comment = self._prepare_pr_answer()
|
pr_comment = self._prepare_pr_answer()
|
||||||
if self.git_provider.is_supported("gfm_markdown") and get_settings().pr_questions.enable_help_text:
|
|
||||||
pr_comment += "<hr>\n\n<details> <summary><strong>✨ Usage guide:</strong></summary><hr> \n\n"
|
|
||||||
pr_comment += HelpMessage.get_ask_usage_guide()
|
|
||||||
pr_comment += "\n</details>\n"
|
|
||||||
|
|
||||||
if get_settings().config.publish_output:
|
if get_settings().config.publish_output:
|
||||||
get_logger().info('Pushing answer...')
|
get_logger().info('Pushing answer...')
|
||||||
self.git_provider.publish_comment(pr_comment)
|
self.git_provider.publish_comment(pr_comment)
|
||||||
|
|||||||
@ -17,7 +17,7 @@ from pr_agent.config_loader import get_settings
|
|||||||
from pr_agent.git_providers import get_git_provider
|
from pr_agent.git_providers import get_git_provider
|
||||||
from pr_agent.git_providers.git_provider import IncrementalPR, get_main_pr_language
|
from pr_agent.git_providers.git_provider import IncrementalPR, get_main_pr_language
|
||||||
from pr_agent.log import get_logger
|
from pr_agent.log import get_logger
|
||||||
from pr_agent.servers.help import HelpMessage
|
from pr_agent.servers.help import actions_help_text, bot_help_text
|
||||||
|
|
||||||
|
|
||||||
class PRReviewer:
|
class PRReviewer:
|
||||||
@ -98,7 +98,14 @@ class PRReviewer:
|
|||||||
self.incremental = IncrementalPR(is_incremental)
|
self.incremental = IncrementalPR(is_incremental)
|
||||||
|
|
||||||
async def run(self) -> None:
|
async def run(self) -> None:
|
||||||
|
"""
|
||||||
|
Review the pull request and generate feedback.
|
||||||
|
"""
|
||||||
|
|
||||||
try:
|
try:
|
||||||
|
# if self.is_auto and not get_settings().pr_reviewer.automatic_review:
|
||||||
|
# get_logger().info(f'Automatic review is disabled {self.pr_url}')
|
||||||
|
# return None
|
||||||
if self.incremental.is_incremental and not self._can_run_incremental_review():
|
if self.incremental.is_incremental and not self._can_run_incremental_review():
|
||||||
return None
|
return None
|
||||||
|
|
||||||
@ -108,9 +115,6 @@ class PRReviewer:
|
|||||||
self.git_provider.publish_comment("Preparing review...", is_temporary=True)
|
self.git_provider.publish_comment("Preparing review...", is_temporary=True)
|
||||||
|
|
||||||
await retry_with_fallback_models(self._prepare_prediction)
|
await retry_with_fallback_models(self._prepare_prediction)
|
||||||
if not self.prediction:
|
|
||||||
self.git_provider.remove_initial_comment()
|
|
||||||
return None
|
|
||||||
|
|
||||||
get_logger().info('Preparing PR review...')
|
get_logger().info('Preparing PR review...')
|
||||||
pr_comment = self._prepare_pr_review()
|
pr_comment = self._prepare_pr_review()
|
||||||
@ -137,14 +141,19 @@ class PRReviewer:
|
|||||||
get_logger().error(f"Failed to review PR: {e}")
|
get_logger().error(f"Failed to review PR: {e}")
|
||||||
|
|
||||||
async def _prepare_prediction(self, model: str) -> None:
|
async def _prepare_prediction(self, model: str) -> None:
|
||||||
|
"""
|
||||||
|
Prepare the AI prediction for the pull request review.
|
||||||
|
|
||||||
|
Args:
|
||||||
|
model: A string representing the AI model to be used for the prediction.
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
None
|
||||||
|
"""
|
||||||
get_logger().info('Getting PR diff...')
|
get_logger().info('Getting PR diff...')
|
||||||
self.patches_diff = get_pr_diff(self.git_provider, self.token_handler, model)
|
self.patches_diff = get_pr_diff(self.git_provider, self.token_handler, model)
|
||||||
if self.patches_diff:
|
|
||||||
get_logger().info('Getting AI prediction...')
|
get_logger().info('Getting AI prediction...')
|
||||||
self.prediction = await self._get_prediction(model)
|
self.prediction = await self._get_prediction(model)
|
||||||
else:
|
|
||||||
get_logger().error(f"Error getting PR diff")
|
|
||||||
self.prediction = None
|
|
||||||
|
|
||||||
async def _get_prediction(self, model: str) -> str:
|
async def _get_prediction(self, model: str) -> str:
|
||||||
"""
|
"""
|
||||||
@ -240,11 +249,16 @@ class PRReviewer:
|
|||||||
data.move_to_end('Incremental PR Review', last=False)
|
data.move_to_end('Incremental PR Review', last=False)
|
||||||
|
|
||||||
markdown_text = convert_to_markdown(data, self.git_provider.is_supported("gfm_markdown"))
|
markdown_text = convert_to_markdown(data, self.git_provider.is_supported("gfm_markdown"))
|
||||||
|
user = self.git_provider.get_user_id()
|
||||||
|
|
||||||
# Add help text if gfm_markdown is supported
|
# Add help text if gfm_markdown is supported
|
||||||
if self.git_provider.is_supported("gfm_markdown") and get_settings().pr_reviewer.enable_help_text:
|
if self.git_provider.is_supported("gfm_markdown") and get_settings().pr_reviewer.enable_help_text:
|
||||||
markdown_text += "<hr>\n\n<details> <summary><strong>✨ Usage guide:</strong></summary><hr> \n\n"
|
markdown_text += "\n\n<details> <summary><strong>✨ Usage tips:</strong></summary><hr> \n\n"
|
||||||
markdown_text += HelpMessage.get_review_usage_guide()
|
bot_user = "[bot]" if get_settings().github_app.override_deployment_type else get_settings().github_app.bot_user
|
||||||
|
if user and bot_user not in user and not get_settings().get("CONFIG.CLI_MODE", False):
|
||||||
|
markdown_text += bot_help_text(user)
|
||||||
|
else:
|
||||||
|
markdown_text += actions_help_text
|
||||||
markdown_text += "\n</details>\n"
|
markdown_text += "\n</details>\n"
|
||||||
|
|
||||||
# Add custom labels from the review prediction (effort, security)
|
# Add custom labels from the review prediction (effort, security)
|
||||||
|
|||||||
@ -5,6 +5,7 @@ from typing import List
|
|||||||
import openai
|
import openai
|
||||||
import pandas as pd
|
import pandas as pd
|
||||||
import pinecone
|
import pinecone
|
||||||
|
import lancedb
|
||||||
from pinecone_datasets import Dataset, DatasetMetadata
|
from pinecone_datasets import Dataset, DatasetMetadata
|
||||||
from pydantic import BaseModel, Field
|
from pydantic import BaseModel, Field
|
||||||
|
|
||||||
@ -107,7 +108,6 @@ class PRSimilarIssue:
|
|||||||
get_logger().info('No new issues to update')
|
get_logger().info('No new issues to update')
|
||||||
|
|
||||||
elif get_settings().pr_similar_issue.vectordb == "lancedb":
|
elif get_settings().pr_similar_issue.vectordb == "lancedb":
|
||||||
import lancedb # import lancedb only if needed
|
|
||||||
self.db = lancedb.connect(get_settings().lancedb.uri)
|
self.db = lancedb.connect(get_settings().lancedb.uri)
|
||||||
self.table = None
|
self.table = None
|
||||||
|
|
||||||
|
|||||||
@ -1,5 +1,5 @@
|
|||||||
aiohttp==3.9.1
|
aiohttp==3.9.1
|
||||||
atlassian-python-api==3.41.4
|
atlassian-python-api==3.39.0
|
||||||
azure-devops==7.1.0b3
|
azure-devops==7.1.0b3
|
||||||
boto3==1.33.6
|
boto3==1.33.6
|
||||||
dynaconf==3.2.4
|
dynaconf==3.2.4
|
||||||
|
|||||||
Reference in New Issue
Block a user