Merge commit 'd1586ddd77b86f0d3b29aee3370f29624799e388' into hl/incremental_review

This commit is contained in:
Hussam.lawen
2023-07-19 16:14:33 +03:00
2 changed files with 17 additions and 20 deletions

View File

@ -50,9 +50,10 @@ CodiumAI `PR-Agent` is an open-source tool aiming to help developers review PRs
</div> </div>
<div align="left"> <div align="left">
- [Live demo](#live-demo)
- [Overview](#overview) - [Overview](#overview)
- [Quickstart](#quickstart) - [Try it now](#try-it-now)
- [Installation](#installation)
- [Usage and tools](#usage-and-tools) - [Usage and tools](#usage-and-tools)
- [Configuration](./CONFIGURATION.md) - [Configuration](./CONFIGURATION.md)
- [How it works](#how-it-works) - [How it works](#how-it-works)
@ -60,15 +61,7 @@ CodiumAI `PR-Agent` is an open-source tool aiming to help developers review PRs
- [Similar projects](#similar-projects) - [Similar projects](#similar-projects)
</div> </div>
## Live demo
Experience GPT-4 powered PR review on your public GitHub repository with our hosted PR-Agent. To try it, just mention `@CodiumAI-Agent` and add the desired command in any PR comment! The agent will generate a response based on your command.
![Review generation process](https://codium.ai/images/demo.gif)
To set up your own PR-Agent, see the [Quickstart](#Quickstart) section
---
## Overview ## Overview
`PR-Agent` offers extensive pull request functionalities across various git providers: `PR-Agent` offers extensive pull request functionalities across various git providers:
| | | GitHub | Gitlab | Bitbucket | | | | GitHub | Gitlab | Bitbucket |
@ -99,18 +92,24 @@ Examples for invoking the different tools via the [CLI](#quickstart):
In the [configuration](./CONFIGURATION.md) file you can select your git provider (GitHub, Gitlab, Bitbucket), and further configure the different tools. In the [configuration](./CONFIGURATION.md) file you can select your git provider (GitHub, Gitlab, Bitbucket), and further configure the different tools.
## Quickstart ## Try it now
Try GPT-4 powered PR-Agent on your public GitHub repository for free. Just mention `@CodiumAI-Agent` and add the desired command in any PR comment! The agent will generate a response based on your command.
![Review generation process](https://codium.ai/images/demo.gif)
To set up your own PR-Agent, see the [Quickstart](#Quickstart) section
---
## Installation
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/), with access to GPT-4. 1. An OpenAI key from [here](https://platform.openai.com/), with access to GPT-4.
2. A GitHub personal access token (classic) with the repo scope. 2. A GitHub personal access token (classic) with the repo scope.
There are several ways to use PR-Agent. Let's start with the simplest one: There are several ways to use PR-Agent:
## Install
Here are several ways to install and run PR-Agent:
- [Method 1: Use Docker image (no installation required)](INSTALL.md#method-1-use-docker-image-no-installation-required) - [Method 1: Use Docker image (no installation required)](INSTALL.md#method-1-use-docker-image-no-installation-required)
- [Method 2: Run as a GitHub Action](INSTALL.md#method-2-run-as-a-github-action) - [Method 2: Run as a GitHub Action](INSTALL.md#method-2-run-as-a-github-action)

View File

@ -34,8 +34,7 @@ def convert_to_markdown(output_data: dict) -> str:
elif isinstance(value, list): elif isinstance(value, list):
if key.lower() == 'code suggestions': if key.lower() == 'code suggestions':
markdown_text += "\n" # just looks nicer with additional line breaks markdown_text += "\n" # just looks nicer with additional line breaks
# emoji = emojis.get(key, "‣") # Use a dash if no emoji is found for the key emoji = emojis.get(key, "")
emoji = ""
markdown_text += f"- {emoji} **{key}:**\n\n" markdown_text += f"- {emoji} **{key}:**\n\n"
for item in value: for item in value:
if isinstance(item, dict) and key.lower() == 'code suggestions': if isinstance(item, dict) and key.lower() == 'code suggestions':
@ -43,8 +42,7 @@ def convert_to_markdown(output_data: dict) -> str:
elif item: elif item:
markdown_text += f" - {item}\n" markdown_text += f" - {item}\n"
elif value != 'n/a': elif value != 'n/a':
# emoji = emojis.get(key, "‣") # Use a dash if no emoji is found for the key emoji = emojis.get(key, "")
emoji = ""
markdown_text += f"- {emoji} **{key}:** {value}\n" markdown_text += f"- {emoji} **{key}:** {value}\n"
return markdown_text return markdown_text