Update GitHub app

Update Github polling

.github/workflows/review.yaml

@@ -8,7 +8,7 @@ jobs:
     steps:
       - name: PR Agent action step
         id: pragent
-        uses: Codium-ai/pr-agent@feature/github_action
+        uses: Codium-ai/pr-agent@main
         env:
           OPENAI_KEY: ${{ secrets.OPENAI_KEY }}
           OPENAI_ORG: ${{ secrets.OPENAI_ORG }}

Dockerfile.github_action_dockerhub

@@ -0,0 +1 @@
+FROM codiumai/pr-agent:github_action

README.md

@@ -9,18 +9,40 @@
 
 [![GitHub license](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://github.com/Codium-ai/pr-agent/blob/main/LICENSE)
 [![Discord](https://badgen.net/badge/icon/discord?icon=discord&label&color=purple)](https://discord.com/channels/1057273017547378788/1126104260430528613)
-
-CodiumAI `pr-agent` is an open-source tool aiming to help developers review PRs faster and more efficiently. It automatically analyzes the PR, provides feedback and suggestions, and can answer free-text questions.
-
 </div>
+<div align="left">
+
+CodiumAI `pr-agent` is an open-source tool aiming to help developers review PRs faster and more efficiently. It automatically analyzes the PR and can provide several types of feedback:
+
+**Auto-Description**: Automatically generating PR description - name, type, summary, and code walkthrough.
+\
+**PR Review**: Feedback about the PR main theme, type, relevant tests, security issues, focused, and various suggestions for the PR content.
+\
+**Question Answering**: Answering free-text questions about the PR.
+\
+**Code Suggestion**: Committable code suggestions for improving the PR.
+
+Example results:
+</div>
+<div align="center">
+<p float="center">
+<img src="./pics/pr_reviewer_1.png" width="800">
+</p>
+<p float="center">
+<img src="./pics/pr_code_suggestions.png" width="800">
+</p>
+</div>
+<div align="left">
 
 - [Live demo](#live-demo)
-- [Quickstart](#Quickstart)
+- [Overview](#overview)
+- [Quickstart](#quickstart)
 - [Usage and tools](#usage-and-tools)
-- [Configuration](#Configuration)
+- [Configuration](#configuration)
 - [How it works](#how-it-works)
 - [Roadmap](#roadmap)
 - [Similar projects](#similar-projects)
+</div>
 
 ## Live demo
 
@@ -31,6 +53,25 @@ Experience GPT-4 powered PR review on your public GitHub repository with our hos
 To set up your own pr-agent, see the [Quickstart](#Quickstart) section
 
 ---
+## Overview
+`pr-agent` offers extensive pull request functionalities across various git providers:
+|       |                                             | Github | Gitlab | Bitbucket |
+|-------|---------------------------------------------|--------|--------|-----------|
+| TOOLS | Review                                      | ✓      | ✓      | ✓         |
+|       | ⮑ Inline review                             | ✓     | ✓      |           |
+|       | Ask                                         | ✓      | ✓      |           |
+|       | Auto-Description                            | ✓      |        |           |
+|       | Improve Code                                | ✓      |        |           |
+|       |                                             |        |        |           |
+| USAGE | CLI                                         | ✓      | ✓      | ✓         |
+|       | Tagging bot                                 | ✓      | ✓      |           |
+|       | Actions                                     | ✓      |        |           |
+|       |                                             |        |        |           |
+| CORE  | PR compression                              | ✓      | ✓      | ✓         |
+|       | Repo language prioritization                | ✓      | ✓      | ✓         |
+|       | Adaptive and token-aware<br />file patch fitting | ✓      | ✓      | ✓         |
+
+
 
 ## Quickstart
 

action.yaml

@@ -2,4 +2,4 @@ name: 'PR Agent'
 description: 'Summarize, review and suggest improvements for pull requests'
 runs:
   using: 'docker'
-  image: 'Dockerfile.github_action'
+  image: 'Dockerfile.github_action_dockerhub'

pr_agent/agent/pr_agent.py

@@ -1,5 +1,7 @@
 import re
 
+from pr_agent.tools.pr_code_suggestions import PRCodeSuggestions
+from pr_agent.tools.pr_description import PRDescription
 from pr_agent.tools.pr_questions import PRQuestions
 from pr_agent.tools.pr_reviewer import PRReviewer
 
@@ -8,17 +10,20 @@ class PRAgent:
     def __init__(self):
         pass
 
-    async def handle_request(self, pr_url, request):
+    async def handle_request(self, pr_url, request) -> bool:
-        if 'please review' in request.lower() or 'review' == request.lower().strip() or len(request) == 0:
+        if any(cmd in request for cmd in ["/review", "/review_pr"]):
-            reviewer = PRReviewer(pr_url)
+            await PRReviewer(pr_url).review()
-            await reviewer.review()
+        elif any(cmd in request for cmd in ["/describe", "/describe_pr"]):
-
+            await PRDescription(pr_url).describe()
+        elif any(cmd in request for cmd in ["/improve", "/improve_code"]):
+            await PRCodeSuggestions(pr_url).suggest()
+        elif any(cmd in request for cmd in ["/ask", "/ask_question"]):
+            pattern = r'(/ask|/ask_question)\s*(.*)'
+            matches = re.findall(pattern, request, re.IGNORECASE)
+            if matches:
+                question = matches[0][1]
+                await PRQuestions(pr_url, question).answer()
         else:
-            if "please answer" in request.lower():
+            return False
-                question = re.split(r'(?i)please answer', request)[1].strip()
+
-            elif request.lower().strip().startswith("answer"):
+        return True
-                question = re.split(r'(?i)answer', request)[1].strip()
-            else:
-                question = request
-            answerer = PRQuestions(pr_url, question)
-            await answerer.answer()

pr_agent/servers/github_action_runner.py

@@ -1,8 +1,11 @@
 import asyncio
 import json
 import os
+import re
 
 from pr_agent.config_loader import settings
+from pr_agent.tools.pr_code_suggestions import PRCodeSuggestions
+from pr_agent.tools.pr_description import PRDescription
 from pr_agent.tools.pr_questions import PRQuestions
 from pr_agent.tools.pr_reviewer import PRReviewer
 
@@ -16,10 +19,11 @@ async def run_action():
     if not GITHUB_EVENT_PATH:
         print("GITHUB_EVENT_PATH not set")
         return
-    event_payload = json.load(open(GITHUB_EVENT_PATH, 'r'))
+    try:
-    RUNNER_DEBUG = os.environ.get('RUNNER_DEBUG', None)
+        event_payload = json.load(open(GITHUB_EVENT_PATH, 'r'))
-    if not RUNNER_DEBUG:
+    except json.decoder.JSONDecodeError as e:
-        print("RUNNER_DEBUG not set")
+        print(f"Failed to parse JSON: {e}")
+        return
     OPENAI_KEY = os.environ.get('OPENAI_KEY', None)
     if not OPENAI_KEY:
         print("OPENAI_KEY not set")
@@ -48,10 +52,21 @@ async def run_action():
             if comment_body:
                 pr_url = event_payload.get("issue", {}).get("pull_request", {}).get("url", None)
                 if pr_url:
-                    if comment_body.strip().lower() == "review":
+                    body = comment_body.strip().lower()
+                    if any(cmd in body for cmd in ["/review", "/review_pr"]):
                         await PRReviewer(pr_url).review()
-                    elif comment_body.lstrip().lower().startswith("answer"):
+                    elif any(cmd in body for cmd in ["/describe", "/describe_pr"]):
-                        await PRQuestions(pr_url, comment_body).answer()
+                        await PRDescription(pr_url).describe()
+                    elif any(cmd in body for cmd in ["/improve", "/improve_code"]):
+                        await PRCodeSuggestions(pr_url).suggest()
+                    elif any(cmd in body for cmd in ["/ask", "/ask_question"]):
+                        pattern = r'(/ask|/ask_question)\s*(.*)'
+                        matches = re.findall(pattern, comment_body, re.IGNORECASE)
+                        if matches:
+                            question = matches[0][1]
+                            await PRQuestions(pr_url, question).answer()
+                    else:
+                        print(f"Unknown command: {body}")
 
 
 if __name__ == '__main__':

pr_agent/servers/github_app.py

@@ -56,7 +56,7 @@ async def handle_request(body):
         api_url = pull_request.get("url", None)
         if api_url is None:
             return {}
-        await agent.handle_request(api_url, "please review")
+        await agent.handle_request(api_url, "/review")
     else:
         return {}
 

pr_agent/servers/github_polling.py

@@ -1,5 +1,6 @@
 import asyncio
 import logging
+import re
 import sys
 from datetime import datetime, timezone
 
@@ -8,6 +9,11 @@ import aiohttp
 from pr_agent.agent.pr_agent import PRAgent
 from pr_agent.config_loader import settings
 from pr_agent.git_providers import get_git_provider
+from pr_agent.servers.help import bot_help_text
+from pr_agent.tools.pr_code_suggestions import PRCodeSuggestions
+from pr_agent.tools.pr_description import PRDescription
+from pr_agent.tools.pr_questions import PRQuestions
+from pr_agent.tools.pr_reviewer import PRReviewer
 
 logging.basicConfig(stream=sys.stdout, level=logging.DEBUG)
 NOTIFICATION_URL = "https://api.github.com/notifications"
@@ -25,6 +31,7 @@ async def polling_loop():
     last_modified = [None]
     git_provider = get_git_provider()()
     user_id = git_provider.get_user_id()
+    agent = PRAgent()
     try:
         deployment_type = settings.github.deployment_type
         token = settings.github.user_token
@@ -83,8 +90,13 @@ async def polling_loop():
                                             if user_tag not in comment_body:
                                                 continue
                                             rest_of_comment = comment_body.split(user_tag)[1].strip()
-                                            agent = PRAgent()
+
-                                            await agent.handle_request(pr_url, rest_of_comment)
+                                            success = await agent.handle_request(pr_url, rest_of_comment)
+                                            if not success:
+                                                git_provider.set_pr(pr_url)
+                                                git_provider.publish_comment("### How to user PR-Agent\n" +
+                                                                             bot_help_text(user_id))
+
                     elif response.status != 304:
                         print(f"Failed to fetch notifications. Status code: {response.status}")
 

pr_agent/servers/help.py

@@ -0,0 +1,14 @@
+commands_text = "> /review - Ask for a new review after your update the PR\n" \
+                "> /describe - Modify the PR title and description based " \
+                "on the PR's contents.\n" \
+                "> /improve - Suggest improvements to the code in the PR as pull " \
+                "request comments ready to commit.\n" \
+                "> /ask <QUESTION> - Ask a question about the PR.\n"
+
+
+def bot_help_text(user: str):
+    return f"> Tag me in a comment '@{user}' and add one of the following commands:\n" + commands_text
+
+
+actions_help_text = "> Add a comment to to invoke PR-Agent, use one of the following commands:\n" + \
+                    commands_text

pr_agent/tools/pr_reviewer.py

@@ -11,6 +11,7 @@ from pr_agent.algo.utils import convert_to_markdown, try_fix_json
 from pr_agent.config_loader import settings
 from pr_agent.git_providers import get_git_provider
 from pr_agent.git_providers.git_provider import get_main_pr_language
+from pr_agent.servers.help import bot_help_text, actions_help_text
 
 
 class PRReviewer:
@@ -43,7 +44,7 @@ class PRReviewer:
     async def review(self):
         logging.info('Reviewing PR...')
         if settings.config.publish_review:
-            self.git_provider.publish_comment("Preparing review...", is_temporary=True)
+                self.git_provider.publish_comment("Preparing review...", is_temporary=True)
         logging.info('Getting PR diff...')
         self.patches_diff = get_pr_diff(self.git_provider, self.token_handler)
         logging.info('Getting AI prediction...')
@@ -97,14 +98,9 @@ class PRReviewer:
         if not self.cli_mode:
             markdown_text += "\n### How to use\n"
             if user and '[bot]' not in user:
-                markdown_text += f"> Tag me in a comment '@{user}' to ask for a new review after you update the PR.\n"
+                markdown_text += bot_help_text(user)
-                markdown_text += "> You can also tag me and ask any question, " \
-                                 f"for example '@{user} is the PR ready for merge?'"
             else:
-                markdown_text += "> Add a comment that says 'review' to ask for a new review " \
+                markdown_text += actions_help_text
-                                 "after you update the PR.\n"
-                markdown_text += "> You can also add a comment that says 'answer QUESTION', " \
-                                 "for example 'answer is the PR ready for merge?'"
 
         if settings.config.verbosity_level >= 2:
             logging.info(f"Markdown response:\n{markdown_text}")