Merge remote-tracking branch 'origin/main'

fix

.github/workflows/docs-ci.yaml

@@ -0,0 +1,32 @@
+name: docs-ci 
+on:
+  push:
+    branches:
+      - main
+      - add-docs-portal
+    paths:
+      - docs/**
+permissions:
+  contents: write
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Configure Git Credentials
+        run: |
+          git config user.name github-actions[bot]
+          git config user.email 41898282+github-actions[bot]@users.noreply.github.com
+      - uses: actions/setup-python@v5
+        with:
+          python-version: 3.x
+      - run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV 
+      - uses: actions/cache@v4
+        with:
+          key: mkdocs-material-${{ env.cache_id }}
+          path: .cache
+          restore-keys: |
+            mkdocs-material-
+      - run: pip install mkdocs-material 
+      - run: pip install "mkdocs-material[imaging]"
+      - run: mkdocs gh-deploy -f docs/mkdocs.yml --force

.github/workflows/pr-agent-review.yaml

@@ -5,8 +5,9 @@
 name: PR-Agent
 
 on:
-  pull_request:
+# pull_request:
-  issue_comment:
+# issue_comment:
+  workflow_dispatch:
 
 permissions:
   issues: write
@@ -26,7 +27,9 @@ jobs:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           PINECONE.API_KEY: ${{ secrets.PINECONE_API_KEY }}
           PINECONE.ENVIRONMENT: ${{ secrets.PINECONE_ENVIRONMENT }}
-          GITHUB_ACTION.AUTO_REVIEW: true
+          GITHUB_ACTION_CONFIG.AUTO_DESCRIBE: true
-          GITHUB_ACTION.AUTO_IMPROVE: true
+          GITHUB_ACTION_CONFIG.AUTO_REVIEW: true
+          GITHUB_ACTION_CONFIG.AUTO_IMPROVE: true
+
 
 

.gitignore

@@ -5,4 +5,5 @@ __pycache__
 dist/
 *.egg-info/
 build/
-review.md
+.DS_Store
+docs/.cache/

.pr_agent.toml

@@ -1,5 +1,6 @@
 [pr_reviewer]
 enable_review_labels_effort = true
+enable_auto_approval = true
 
 
 [pr_code_suggestions]

INSTALL.md

@@ -1,462 +0,0 @@
-
-## Installation
-
-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.
-2. A GitHub\GitLab\BitBucket personal access token (classic) with the repo scope.
-
-There are several ways to use PR-Agent:
-
-**Locally**
-- [Using Docker image (no installation required)](INSTALL.md#use-docker-image-no-installation-required)
-- [Run from source](INSTALL.md#run-from-source)
-
-**GitHub specific methods**
-- [Run as a GitHub Action](INSTALL.md#run-as-a-github-action)
-- [Run as a polling server](INSTALL.md#run-as-a-polling-server)
-- [Run as a GitHub App](INSTALL.md#run-as-a-github-app)
-- [Deploy as a Lambda Function](INSTALL.md#deploy-as-a-lambda-function)
-- [AWS CodeCommit](INSTALL.md#aws-codecommit-setup)
-
-**GitLab specific methods**
-- [Run a GitLab webhook server](INSTALL.md#run-a-gitlab-webhook-server)
-
-**BitBucket specific methods**
-- [Run as a Bitbucket Pipeline](INSTALL.md#run-as-a-bitbucket-pipeline)
-- [Run on a hosted app](INSTALL.md#run-on-a-hosted-bitbucket-app)
-- [Bitbucket server and data center](INSTALL.md#bitbucket-server-and-data-center)
----
-
-### Use Docker image (no installation required)
-
-A list of the relevant tools can be found in the [tools guide](./docs/TOOLS_GUIDE.md).
-
-To invoke a tool (for example `review`), you can run directly from the Docker image. Here's how:
-
-- For GitHub:
-```
-docker run --rm -it -e OPENAI.KEY=<your key> -e GITHUB.USER_TOKEN=<your token> codiumai/pr-agent:latest --pr_url <pr_url> review
-```
-
-- For GitLab:
-```
-docker run --rm -it -e OPENAI.KEY=<your key> -e CONFIG.GIT_PROVIDER=gitlab -e GITLAB.PERSONAL_ACCESS_TOKEN=<your token> codiumai/pr-agent:latest --pr_url <pr_url> review
-```
-
-Note: If you have a dedicated GitLab instance, you need to specify the custom url as variable:
-```
-docker run --rm -it -e OPENAI.KEY=<your key> -e CONFIG.GIT_PROVIDER=gitlab -e GITLAB.PERSONAL_ACCESS_TOKEN=<your token> GITLAB.URL=<your gitlab instance url> codiumai/pr-agent:latest --pr_url <pr_url> review
-```
-
-- For BitBucket:
-```
-docker run --rm -it -e CONFIG.GIT_PROVIDER=bitbucket -e OPENAI.KEY=$OPENAI_API_KEY -e BITBUCKET.BEARER_TOKEN=$BITBUCKET_BEARER_TOKEN codiumai/pr-agent:latest --pr_url=<pr_url> review
-```
-
-For other git providers, update CONFIG.GIT_PROVIDER accordingly, and check the `pr_agent/settings/.secrets_template.toml` file for the environment variables expected names and values.
-
----
-
-
-If you want to ensure you're running a specific version of the Docker image, consider using the image's digest:
-```bash
-docker run --rm -it -e OPENAI.KEY=<your key> -e GITHUB.USER_TOKEN=<your token> codiumai/pr-agent@sha256:71b5ee15df59c745d352d84752d01561ba64b6d51327f97d46152f0c58a5f678 --pr_url <pr_url> review
-```
-
-Or you can run a [specific released versions](./RELEASE_NOTES.md) of pr-agent, for example:
-```
-codiumai/pr-agent@v0.9
-```
-
----
-
-### Run from source
-
-1. Clone this repository:
-
-```
-git clone https://github.com/Codium-ai/pr-agent.git
-```
-
-2. Install the requirements in your favorite virtual environment:
-
-```
-pip install -r requirements.txt
-```
-
-3. Copy the secrets template file and fill in your OpenAI key and your GitHub user token:
-
-```
-cp pr_agent/settings/.secrets_template.toml pr_agent/settings/.secrets.toml
-chmod 600 pr_agent/settings/.secrets.toml
-# Edit .secrets.toml file
-```
-
-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> ask <your question>
-python3 -m pr_agent.cli --pr_url <pr_url> describe
-python3 -m pr_agent.cli --pr_url <pr_url> improve
-python3 -m pr_agent.cli --pr_url <pr_url> add_docs
-python3 -m pr_agent.cli --pr_url <pr_url> generate_labels
-python3 -m pr_agent.cli --issue_url <issue_url> similar_issue
-...
-```
-
----
-
-### Run as a GitHub Action
-
-You can use our pre-built Github Action Docker image to run PR-Agent as a Github Action.
-
-1. Add the following file to your repository under `.github/workflows/pr_agent.yml`:
-
-```yaml
-on:
-  pull_request:
-  issue_comment:
-jobs:
-  pr_agent_job:
-    runs-on: ubuntu-latest
-    permissions:
-      issues: write
-      pull-requests: write
-      contents: write
-    name: Run pr agent on every pull request, respond to user comments
-    steps:
-      - name: PR Agent action step
-        id: pragent
-        uses: Codium-ai/pr-agent@main
-        env:
-          OPENAI_KEY: ${{ secrets.OPENAI_KEY }}
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-```
-** if you want to pin your action to a specific release (v0.7 for example) for stability reasons, use:
-```yaml
-on:
-  pull_request:
-  issue_comment:
-
-jobs:
-  pr_agent_job:
-    runs-on: ubuntu-latest
-    permissions:
-      issues: write
-      pull-requests: write
-      contents: write
-    name: Run pr agent on every pull request, respond to user comments
-    steps:
-      - name: PR Agent action step
-        id: pragent
-        uses: Codium-ai/pr-agent@v0.7
-        env:
-          OPENAI_KEY: ${{ secrets.OPENAI_KEY }}
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-```
-2. Add the following secret to your repository under `Settings > Secrets and variables > Actions > New repository secret > Add secret`:
-
-```
-Name = OPENAI_KEY
-Secret = <your key>
-```
-
-The GITHUB_TOKEN secret is automatically created by GitHub.
-
-3. Merge this change to your main branch.
-When you open your next PR, you should see a comment from `github-actions` bot with a review of your PR, and instructions on how to use the rest of the tools.
-
-4. You may configure PR-Agent by adding environment variables under the env section corresponding to any configurable property in the [configuration](pr_agent/settings/configuration.toml) file. Some examples:
-```yaml
-      env:
-        # ... previous environment values
-        OPENAI.ORG: "<Your organization name under your OpenAI account>"
-        PR_REVIEWER.REQUIRE_TESTS_REVIEW: "false" # Disable tests review
-        PR_CODE_SUGGESTIONS.NUM_CODE_SUGGESTIONS: 6 # Increase number of code suggestions
-```
-
----
-
-### Run as a polling server
-Request reviews by tagging your GitHub user on a PR
-
-Follow [steps 1-3](#run-as-a-github-action) of the GitHub Action setup.
-
-Run the following command to start the server:
-
-```
-python pr_agent/servers/github_polling.py
-```
-
----
-
-### Run as a GitHub App
-Allowing you to automate the review process on your private or public repositories.
-
-1. Create a GitHub App from the [Github Developer Portal](https://docs.github.com/en/developers/apps/creating-a-github-app).
-
-   - Set the following permissions:
-     - Pull requests: Read & write
-     - Issue comment: Read & write
-     - Metadata: Read-only
-     - Contents: Read-only
-   - Set the following events:
-     - Issue comment
-     - Pull request
-     - Push (if you need to enable triggering on PR update)
-
-2. Generate a random secret for your app, and save it for later. For example, you can use:
-
-```
-WEBHOOK_SECRET=$(python -c "import secrets; print(secrets.token_hex(10))")
-```
-
-3. Acquire the following pieces of information from your app's settings page:
-
-   - App private key (click "Generate a private key" and save the file)
-   - App ID
-
-4. Clone this repository:
-
-```
-git clone https://github.com/Codium-ai/pr-agent.git
-```
-
-5. Copy the secrets template file and fill in the following:
-    ```
-    cp pr_agent/settings/.secrets_template.toml pr_agent/settings/.secrets.toml
-    # Edit .secrets.toml file
-    ```
-   - Your OpenAI key.
-   - Copy your app's private key to the private_key field.
-   - Copy your app's ID to the app_id field.
-   - Copy your app's webhook secret to the webhook_secret field.
-   - Set deployment_type to 'app' in [configuration.toml](./pr_agent/settings/configuration.toml)
-
-> The .secrets.toml file is not copied to the Docker image by default, and is only used for local development.
-> If you want to use the .secrets.toml file in your Docker image, you can add remove it from the .dockerignore file.
-> In most production environments, you would inject the secrets file as environment variables or as mounted volumes.
-> For example, in order to inject a secrets file as a volume in a Kubernetes environment you can update your pod spec to include the following,
-> assuming you have a secret named `pr-agent-settings` with a key named `.secrets.toml`:
-```
-       volumes:
-        - name: settings-volume
-          secret:
-            secretName: pr-agent-settings
-// ...
-       containers:
-// ...
-          volumeMounts:
-            - mountPath: /app/pr_agent/settings_prod
-              name: settings-volume
-```
-
-> Another option is to set the secrets as environment variables in your deployment environment, for example `OPENAI.KEY` and `GITHUB.USER_TOKEN`.
-
-6. Build a Docker image for the app and optionally push it to a Docker repository. We'll use Dockerhub as an example:
-
-```
-docker build . -t codiumai/pr-agent:github_app --target github_app -f docker/Dockerfile
-docker push codiumai/pr-agent:github_app  # Push to your Docker repository
-```
-
-7. Host the app using a server, serverless function, or container environment. Alternatively, for development and
-   debugging, you may use tools like smee.io to forward webhooks to your local machine.
-    You can check [Deploy as a Lambda Function](#deploy-as-a-lambda-function)
-
-8. Go back to your app's settings, and set the following:
-
-   - Webhook URL: The URL of your app's server or the URL of the smee.io channel.
-   - Webhook secret: The secret you generated earlier.
-
-9. Install the app by navigating to the "Install App" tab and selecting your desired repositories.
-
-> **Note:** When running PR-Agent from GitHub App, the default configuration file (configuration.toml) will be loaded.<br>
-> However, you can override the default tool parameters by uploading a local configuration file `.pr_agent.toml`<br>
-> For more information please check out the [USAGE GUIDE](./Usage.md#working-with-github-app)
----
-
-### Deploy as a Lambda Function
-
-1. Follow steps 1-5 of [Method 5](#run-as-a-github-app).
-2. Build a docker image that can be used as a lambda function
-    ```shell
-    docker buildx build --platform=linux/amd64 . -t codiumai/pr-agent:serverless -f docker/Dockerfile.lambda
-   ```
-3. Push image to ECR
-    ```shell
-	docker tag codiumai/pr-agent:serverless <AWS_ACCOUNT>.dkr.ecr.<AWS_REGION>.amazonaws.com/codiumai/pr-agent:serverless
-	docker push <AWS_ACCOUNT>.dkr.ecr.<AWS_REGION>.amazonaws.com/codiumai/pr-agent:serverless
-    ```
-4. Create a lambda function that uses the uploaded image. Set the lambda timeout to be at least 3m.
-5. Configure the lambda function to have a Function URL.
-6. In the environment variables of the Lambda function, specify `AZURE_DEVOPS_CACHE_DIR` to a writable location such as /tmp. (see [link](https://github.com/Codium-ai/pr-agent/pull/450#issuecomment-1840242269))
-7. Go back to steps 8-9 of [Method 5](#run-as-a-github-app) with the function url as your Webhook URL.
-    The Webhook URL would look like `https://<LAMBDA_FUNCTION_URL>/api/v1/github_webhooks`
-
----
-
-### AWS CodeCommit Setup
-
-Not all features have been added to CodeCommit yet.  As of right now, CodeCommit has been implemented to run the pr-agent CLI on the command line, using AWS credentials stored in environment variables.  (More features will be added in the future.)  The following is a set of instructions to have pr-agent do a review of your CodeCommit pull request from the command line:
-
-1. Create an IAM user that you will use to read CodeCommit pull requests and post comments
-    * Note: That user should have CLI access only, not Console access
-2. Add IAM permissions to that user, to allow access to CodeCommit (see IAM Role example below)
-3. Generate an Access Key for your IAM user
-4. Set the Access Key and Secret using environment variables (see Access Key example below)
-5. Set the `git_provider` value to `codecommit` in the `pr_agent/settings/configuration.toml` settings file
-6. Set the `PYTHONPATH` to include your `pr-agent` project directory
-    * Option A: Add `PYTHONPATH="/PATH/TO/PROJECTS/pr-agent` to your `.env` file
-    * Option B: Set `PYTHONPATH` and run the CLI in one command, for example:
-        * `PYTHONPATH="/PATH/TO/PROJECTS/pr-agent python pr_agent/cli.py [--ARGS]`
-
-##### AWS CodeCommit IAM Role Example
-
-Example IAM permissions to that user to allow access to CodeCommit:
-
-* Note: The following is a working example of IAM permissions that has read access to the repositories and write access to allow posting comments
-* Note: If you only want pr-agent to review your pull requests, you can tighten the IAM permissions further, however this IAM example will work, and allow the pr-agent to post comments to the PR
-* Note: You may want to replace the `"Resource": "*"` with your list of repos, to limit access to only those repos
-
-```
-{
-    "Version": "2012-10-17",
-    "Statement": [
-        {
-            "Effect": "Allow",
-            "Action": [
-                "codecommit:BatchDescribe*",
-                "codecommit:BatchGet*",
-                "codecommit:Describe*",
-                "codecommit:EvaluatePullRequestApprovalRules",
-                "codecommit:Get*",
-                "codecommit:List*",
-                "codecommit:PostComment*",
-                "codecommit:PutCommentReaction",
-                "codecommit:UpdatePullRequestDescription",
-                "codecommit:UpdatePullRequestTitle"
-            ],
-            "Resource": "*"
-        }
-    ]
-}
-```
-
-##### AWS CodeCommit Access Key and Secret
-
-Example setting the Access Key and Secret using environment variables
-
-```sh
-export AWS_ACCESS_KEY_ID="XXXXXXXXXXXXXXXX"
-export AWS_SECRET_ACCESS_KEY="XXXXXXXXXXXXXXXX"
-export AWS_DEFAULT_REGION="us-east-1"
-```
-
-##### AWS CodeCommit CLI Example
-
-After you set up AWS CodeCommit using the instructions above, here is an example CLI run that tells pr-agent to **review** a given pull request.
-(Replace your specific PYTHONPATH and PR URL in the example)
-
-```sh
-PYTHONPATH="/PATH/TO/PROJECTS/pr-agent" python pr_agent/cli.py \
-  --pr_url https://us-east-1.console.aws.amazon.com/codesuite/codecommit/repositories/MY_REPO_NAME/pull-requests/321 \
-  review
-```
-
----
-
-### Run a GitLab webhook server
-
-1. From the GitLab workspace or group, create an access token. Enable the "api" scope only.
-2. Generate a random secret for your app, and save it for later. For example, you can use:
-
-```
-WEBHOOK_SECRET=$(python -c "import secrets; print(secrets.token_hex(10))")
-```
-3. Follow the instructions to build the Docker image, setup a secrets file and deploy on your own server from [Method 5](#run-as-a-github-app) steps 4-7.
-4. In the secrets file, fill in the following:
-    - Your OpenAI key.
-    - In the [gitlab] section, fill in personal_access_token and shared_secret. The access token can be a personal access token, or a group or project access token.
-    - Set deployment_type to 'gitlab' in [configuration.toml](./pr_agent/settings/configuration.toml)
-5. Create a webhook in GitLab. Set the URL to the URL of your app's server. Set the secret token to the generated secret from step 2.
-In the "Trigger" section, check the ‘comments’ and ‘merge request events’ boxes.
-6. Test your installation by opening a merge request or commenting or a merge request using one of CodiumAI's commands.
-
-
-
-### Run as a Bitbucket Pipeline
-
-
-You can use the Bitbucket Pipeline system to run PR-Agent on every pull request open or update.
-
-1. Add the following file in your repository bitbucket_pipelines.yml
-
-```yaml
-pipelines:
-    pull-requests:
-      '**':
-        - step:
-            name: PR Agent Review
-            image: python:3.10
-            services:
-              - docker
-            script:
-              - docker run -e CONFIG.GIT_PROVIDER=bitbucket -e OPENAI.KEY=$OPENAI_API_KEY -e BITBUCKET.BEARER_TOKEN=$BITBUCKET_BEARER_TOKEN codiumai/pr-agent:latest --pr_url=https://bitbucket.org/$BITBUCKET_WORKSPACE/$BITBUCKET_REPO_SLUG/pull-requests/$BITBUCKET_PR_ID review
-```
-
-2. Add the following secure variables to your repository under Repository settings > Pipelines > Repository variables.
-OPENAI_API_KEY: <your key>
-BITBUCKET_BEARER_TOKEN: <your token>
-
-You can get a Bitbucket token for your repository by following Repository Settings -> Security -> Access Tokens.
-
-Note that comments on a PR are not supported in Bitbucket Pipeline.
-
-
-### Run using CodiumAI-hosted Bitbucket app
-
-Please contact <support@codium.ai> or visit [CodiumAI pricing page](https://www.codium.ai/pricing/) if you're interested in a hosted BitBucket app solution that provides full functionality including PR reviews and comment handling. It's based on the [bitbucket_app.py](https://github.com/Codium-ai/pr-agent/blob/main/pr_agent/git_providers/bitbucket_provider.py) implementation.
-
-
-### Bitbucket Server and Data Center
-
-Login into your on-prem instance of Bitbucket with your service account username and password.
-Navigate to `Manage account`, `HTTP Access tokens`, `Create Token`.
-Generate the token and add it to .secret.toml under `bitbucket_server` section
-
-```toml
-[bitbucket_server]
-bearer_token = "<your key>"
-```
-
-#### Run it as CLI
-
-Modify `configuration.toml`:
-
-```toml
-git_provider="bitbucket_server"
-```
-
-and pass the Pull request URL:
-```shell
-python cli.py --pr_url https://git.onpreminstanceofbitbucket.com/projects/PROJECT/repos/REPO/pull-requests/1 review
-```
-
-#### Run it as service
-
-To run pr-agent as webhook, build the docker image:
-```
-docker build . -t codiumai/pr-agent:bitbucket_server_webhook --target bitbucket_server_webhook -f docker/Dockerfile
-docker push codiumai/pr-agent:bitbucket_server_webhook  # Push to your Docker repository
-```
-
-Navigate to `Projects` or `Repositories`, `Settings`, `Webhooks`, `Create Webhook`.
-Fill the name and URL, Authentication None select the Pull Request Opened checkbox to receive that event as webhook.
-
-The URL should end with `/webhook`, for example: https://domain.com/webhook
-
-=======

README.md

@@ -19,45 +19,150 @@ 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">
     </a>
 </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 10, 2024
+- A new [knowledge-base website](https://pr-agent-docs.codium.ai/) for PR-Agent is now available. It includes detailed information about the different tools, usage guides and more, in an accessible and organized format.
+
+### Jan 8, 2024
+
+- A new tool, [Find Similar Code](https://pr-agent-docs.codium.ai/tools/similar_code/) 💎 is now available. 
+<br>This tool retrieves the most similar code components from inside the organization's codebase, or from open-source code:
+
+<kbd><a href="https://codium.ai/images/pr_agent/similar_code.mp4"><img src="https://codium.ai/images/pr_agent/similar_code_global2.png" width="512"></a></kbd>
+
+(click on the image to see an instructional video)
+
+### Feb 29, 2024
+- You can now use the repo's [wiki page](https://pr-agent-docs.codium.ai/usage-guide/configuration_options/) to set configurations for PR-Agent 💎
+
+<kbd><img src="https://codium.ai/images/pr_agent/wiki_configuration.png" width="512"></kbd>
+
+
+## Overview
 <div style="text-align:left;">
 
-CodiumAI `PR-Agent` is an open-source tool aiming to help developers review pull requests faster and more efficiently. 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.
 
-‣ **Auto Description ([`/describe`](./docs/DESCRIBE.md))**: Automatically generating PR description - title, type, summary, code walkthrough and labels.
+- See the [Installation Guide](https://pr-agent-docs.codium.ai/installation/) for instructions on installing and running the tool on different git platforms.
-\
-‣ **Auto Review ([`/review`](./docs/REVIEW.md))**: Adjustable feedback about the PR main theme, type, relevant tests, security issues, score, and various suggestions for the PR content.
-\
-‣ **Question Answering ([`/ask ...`](./docs/ASK.md))**: Answering free-text questions about the PR.
-\
-‣ **Code Suggestions ([`/improve`](./docs/IMPROVE.md))**: Committable code suggestions for improving the PR.
-\
-‣ **Update Changelog ([`/update_changelog`](./docs/UPDATE_CHANGELOG.md))**: Automatically updating the CHANGELOG.md file with the PR changes.
-\
-‣ **Find Similar Issue ([`/similar_issue`](./docs/SIMILAR_ISSUE.md))**: Automatically retrieves and presents similar issues
-\
-‣ **Add Documentation ([`/add_docs`](./docs/ADD_DOCUMENTATION.md))**: Automatically adds documentation to un-documented functions/classes in the PR.
-\
-‣ **Generate Custom Labels ([`/generate_labels`](./docs/GENERATE_CUSTOM_LABELS.md))**: Automatically suggests custom labels based on the PR code changes.
 
-See the [Installation Guide](./INSTALL.md) for instructions how to install and run the tool on different platforms.
+- See the [Usage Guide](https://pr-agent-docs.codium.ai/usage-guide/) for instructions on running the PR-Agent commands via different interfaces, including _CLI_, _online usage_, or by _automatically triggering_ them when a new PR is opened.
 
-See the [Usage Guide](./Usage.md) for instructions how to run the different tools from _CLI_, _online usage_, or by _automatically triggering_ them when a new PR is opened.
+- See the [Tools Guide](https://pr-agent-docs.codium.ai/tools/) for a detailed description of the different tools.
 
-See the [Tools Guide](./docs/TOOLS_GUIDE.md) for detailed description of the different tools.
+Supported commands per platform:
 
-<h3>Example results:</h3>
+|       |                                                                                                                   | GitHub             | Gitlab             | Bitbucket          | Azure DevOps       |
+|-------|-------------------------------------------------------------------------------------------------------------------|:--------------------:|:--------------------:|:--------------------:|:--------------------:|
+| TOOLS | Review                                                                                                            | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: |
+|       | ⮑ Incremental                                                                                                     | :white_check_mark: |                    |                    |                    |
+|       | ⮑ [SOC2 Compliance](https://pr-agent-docs.codium.ai/tools/review/#soc2-ticket-compliance) 💎            | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: |
+|       | Describe                                                                                                          | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: |
+|       | ⮑ [Inline File Summary](https://pr-agent-docs.codium.ai/tools/describe#inline-file-summary) 💎          | :white_check_mark: |                    |                    |                    |
+|       | Improve                                                                                                           | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: |
+|       | ⮑ Extended                                                                                                        | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: |
+|       | Ask                                                                                                               | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: |
+|       | ⮑ [Ask on code lines](https://pr-agent-docs.codium.ai/tools/ask#ask-lines)                              | :white_check_mark: | :white_check_mark: |                    |                    |
+|       | [Custom Suggestions](https://pr-agent-docs.codium.ai/tools/custom_suggestions/) 💎                      | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: |
+|       | [Test](https://pr-agent-docs.codium.ai/tools/test/) 💎                                                  | :white_check_mark: | :white_check_mark: |                    | :white_check_mark: |
+|       | Reflect and Review                                                                                                | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: |
+|       | Update CHANGELOG.md                                                                                               | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: |
+|       | Find Similar Issue                                                                                                | :white_check_mark: |                    |                    |                    |
+|       | [Add PR Documentation](https://pr-agent-docs.codium.ai/tools/documentation/) 💎                         | :white_check_mark: | :white_check_mark: |                   | :white_check_mark: |
+|       | [Custom Labels](https://pr-agent-docs.codium.ai/tools/custom_labels/) 💎                                | :white_check_mark: | :white_check_mark: |                    | :white_check_mark: |
+|       | [Analyze](https://pr-agent-docs.codium.ai/tools/analyze/) 💎                                            | :white_check_mark: | :white_check_mark: |                    | :white_check_mark: |
+|       | [CI Feedback](https://pr-agent-docs.codium.ai/tools/ci_feedback/) 💎                                    | :white_check_mark: |                    |                    |                    |
+|       | [Similar Code](https://pr-agent-docs.codium.ai/tools/similar_code/) 💎                                  | :white_check_mark: |                    |                    |                    |
+|       |                                                                                                                   |                    |                    |                    |                    |
+| USAGE | CLI                                                                                                               | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: |
+|       | App / webhook                                                                                                     | :white_check_mark: | :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: | :white_check_mark: |
+|       | Repo language prioritization                                                                                      | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: |
+|       | Adaptive and token-aware file patch fitting                                                                       | :white_check_mark: | :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://pr-agent-docs.codium.ai/core-abilities/#static-code-analysis) 💎         | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: |
+|       | [Global and wiki configurations](https://pr-agent-docs.codium.ai/usage-guide/configuration_options/) 💎 | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: |
+|       | [PR interactive actions](https://www.codium.ai/images/pr_agent/pr-actions.mp4) 💎                                 | :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]&#40;./docs/Full_environments.md&#41;)
+___
+
+‣ **Auto Description ([`/describe`](https://pr-agent-docs.codium.ai/tools/describe/))**: Automatically generating PR description - title, type, summary, code walkthrough and labels.
+\
+‣ **Auto Review ([`/review`](https://pr-agent-docs.codium.ai/tools/review/))**: Adjustable feedback about the PR, possible issues, security concerns, review effort and more.
+\
+‣ **Code Suggestions ([`/improve`](https://pr-agent-docs.codium.ai/tools/improve/))**: Code suggestions for improving the PR.
+\
+‣ **Question Answering ([`/ask ...`](https://pr-agent-docs.codium.ai/tools/ask/))**: Answering free-text questions about the PR.
+\
+‣ **Update Changelog ([`/update_changelog`](https://pr-agent-docs.codium.ai/tools/update_changelog/))**: Automatically updating the CHANGELOG.md file with the PR changes.
+\
+‣ **Find Similar Issue ([`/similar_issue`](https://pr-agent-docs.codium.ai/tools/similar_issues/))**: Automatically retrieves and presents similar issues.
+\
+‣ **Add Documentation 💎  ([`/add_docs`](https://pr-agent-docs.codium.ai/tools/documentation/))**: Generates documentation to methods/functions/classes that changed in the PR.
+\
+‣ **Generate Custom Labels 💎 ([`/generate_labels`](https://pr-agent-docs.codium.ai/tools/custom_labels/))**: Generates custom labels for the PR, based on specific guidelines defined by the user.
+\
+‣ **Analyze 💎 ([`/analyze`](https://pr-agent-docs.codium.ai/tools/analyze/))**: Identify code components that changed in the PR, and enables to interactively generate tests, docs, and code suggestions for each component.
+\
+‣ **Custom Suggestions 💎 ([`/custom_suggestions`](https://pr-agent-docs.codium.ai/tools/custom_suggestions/))**: Automatically generates custom suggestions for improving the PR code, based on specific guidelines defined by the user.
+\
+‣ **Generate Tests 💎 ([`/test component_name`](https://pr-agent-docs.codium.ai/tools/test/))**: Generates unit tests for a selected component, based on the PR code changes.
+\
+‣ **CI Feedback 💎 ([`/checks ci_job`](https://pr-agent-docs.codium.ai/tools/ci_feedback/))**: Automatically generates feedback and analysis for a failed CI job.
+\
+‣ **Similar Code 💎 ([`/find_similar_component`](https://pr-agent-docs.codium.ai/tools/similar_code//))**: Retrieves the most similar code components from inside the organization's codebase, or from open-source code.
+___
+
+## Example results
 </div>
-<h4><a href="https://github.com/Codium-ai/pr-agent/pull/229#issuecomment-1687561986">/describe:</a></h4>
+<h4><a href="https://github.com/Codium-ai/pr-agent/pull/530">/describe</a></h4>
 <div align="center">
 <p float="center">
-<img src="https://www.codium.ai/images/describe-2.gif" width="800">
+<img src="https://www.codium.ai/images/pr_agent/describe_new_short_main.png" width="512">
 </p>
 </div>
+<hr>
 
-<h4><a href="https://github.com/Codium-ai/pr-agent/pull/229#issuecomment-1695021901">/review:</a></h4>
+<h4><a href="https://github.com/Codium-ai/pr-agent/pull/732#issuecomment-1975099151">/review</a></h4>
 <div align="center">
 <p float="center">
-<img src="https://www.codium.ai/images/review-2.gif" width="800">
+<kbd>
+<img src="https://www.codium.ai/images/pr_agent/review_new_short_main.png" width="512">
+</kbd>
+</p>
+</div>
+<hr>
+
+<h4><a href="https://github.com/Codium-ai/pr-agent/pull/732#issuecomment-1975099159">/improve</a></h4>
+<div align="center">
+<p float="center">
+<kbd>
+<img src="https://www.codium.ai/images/pr_agent/improve_new_short_main.png" width="512">
+</kbd>
+</p>
+</div>
+<hr>
+
+<h4><a href="https://github.com/Codium-ai/pr-agent/pull/530">/generate_labels</a></h4>
+<div align="center">
+<p float="center">
+<kbd><img src="https://www.codium.ai/images/pr_agent/geneare_custom_labels_main_short.png" width="300"></kbd>
 </p>
 </div>
 
@@ -98,49 +203,14 @@ See the [Tools Guide](./docs/TOOLS_GUIDE.md) for detailed description of the dif
 [//]: # (</div>)
 <div align="left">
 
-## Table of Contents
+
-- [Overview](#overview)
-- [Try it now](#try-it-now)
-- [Installation](#installation)
-- [How it works](#how-it-works)
-- [Why use PR-Agent?](#why-use-pr-agent)
-- [Roadmap](#roadmap)
 </div>
+<hr>
 
 
-## Overview
-`PR-Agent` offers extensive pull request functionalities across various git providers:
-|       |                                             | GitHub | Gitlab | Bitbucket | CodeCommit | Azure DevOps | Gerrit |
-|-------|---------------------------------------------|:------:|:------:|:---------:|:----------:|:----------:|:----------:|
-| TOOLS | Review                                      |   :white_check_mark:    |   :white_check_mark:    |   :white_check_mark:       |   :white_check_mark:    |   :white_check_mark:    |   :white_check_mark:    |
-|       | ⮑ Incremental                              |   :white_check_mark:    |       |           |       |          |     |
-|       | Ask                                         |   :white_check_mark:    |   :white_check_mark:    |   :white_check_mark:          |   :white_check_mark:          | :white_check_mark: |  :white_check_mark:    |
-|       | Auto-Description                            |   :white_check_mark:    |   :white_check_mark:    |   :white_check_mark:        |   :white_check_mark:    |   :white_check_mark:    | :white_check_mark:    |
-|       | Improve Code                                |   :white_check_mark:    |   :white_check_mark:    |   :white_check_mark:        |   :white_check_mark:    |          |    :white_check_mark:    |
-|       | ⮑ Extended                             |   :white_check_mark:    |   :white_check_mark:    |        :white_check_mark:   |   :white_check_mark:    |          | :white_check_mark:    |
-|       | Reflect and Review                          |   :white_check_mark:    |   :white_check_mark:    |   :white_check_mark:        |          |   :white_check_mark:    |    :white_check_mark:    |
-|       | Update CHANGELOG.md                         |   :white_check_mark:    |   :white_check_mark:    |   :white_check_mark:        |   :white_check_mark:    |          |       |
-|       | Find similar issue                          |   :white_check_mark:    |                         |                             |          |          |       |
-|       | Add Documentation                           |   :white_check_mark:    |   :white_check_mark:    |   :white_check_mark:        |   :white_check_mark:    |          |    :white_check_mark:    |
-|       | Generate Labels                           |   :white_check_mark:    |   :white_check_mark:    |         |     |          |      |
-|       |                                             |        |        |      |      |      |
-| USAGE | CLI                                         |   :white_check_mark:    |   :white_check_mark:    |   :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:    |        |           |          |          |
-|       | Web server                                  |       |        |           |          |          |  :white_check_mark:   |
-|       |                                             |        |        |      |      |      |
-| CORE  | PR compression                              |   :white_check_mark:    |   :white_check_mark:    |   :white_check_mark:       | :white_check_mark: |   :white_check_mark:       | :white_check_mark:       |
-|       | Repo language prioritization                |   :white_check_mark:    |   :white_check_mark:    |   :white_check_mark:       | :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:       | :white_check_mark: |   :white_check_mark:       | :white_check_mark:       |
-|       | Multiple models support |   :white_check_mark:    |   :white_check_mark:    |   :white_check_mark:       | :white_check_mark: |   :white_check_mark:       | :white_check_mark:       |
-|       | Incremental PR Review |   :white_check_mark:    |      |      |      |      |      |
-
-Review the [usage guide](./Usage.md) section for detailed instructions how to use the different tools, select the relevant git provider (GitHub, Gitlab, Bitbucket,...), and adjust the configuration file to your needs.
-
 ## Try it now
 
-You can try GPT-4 powered PR-Agent, on your public GitHub repository, instantly. Just mention `@CodiumAI-Agent` and add the desired command in any PR comment. The agent will generate a response based on your command.
+Try the GPT-4 powered PR-Agent instantly on _your public GitHub repository_. Just mention `@CodiumAI-Agent` and add the desired command in any PR comment. The agent will generate a response based on your command.
 For example, add a comment to any pull request with the following text:
 ```
 @CodiumAI-Agent /review
@@ -150,30 +220,42 @@ and the agent will respond with a review of your PR
 ![Review generation process](https://www.codium.ai/images/demo-2.gif)
 
 
-To set up your own PR-Agent, see the [Installation](#installation) section below.
+To set up your own PR-Agent, see the [Installation](https://pr-agent-docs.codium.ai/installation/) section below.
+Note that when you set your own PR-Agent or use CodiumAI hosted PR-Agent, there is no need to mention `@CodiumAI-Agent ...`. Instead, directly start with the command, e.g., `/ask ...`.
 
 ---
 
 ## Installation
-
+To use your own version of PR-Agent, you first need to acquire two tokens:
-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.
 2. A GitHub personal access token (classic) with the repo scope.
 
 There are several ways to use PR-Agent:
 
-- [Method 1: Use Docker image (no installation required)](INSTALL.md#method-1-use-docker-image-no-installation-required)
+**Locally**
-- [Method 2: Run from source](INSTALL.md#method-2-run-from-source)
+- [Use Docker image (no installation required)](https://pr-agent-docs.codium.ai/installation/locally/#use-docker-image-no-installation-required)
-- [Method 3: Run as a GitHub Action](INSTALL.md#method-3-run-as-a-github-action)
+- [Run from source](https://pr-agent-docs.codium.ai/installation/locally/#run-from-source)
-- [Method 4: Run as a polling server](INSTALL.md#method-4-run-as-a-polling-server)
+
-  - Request reviews by tagging your GitHub user on a PR
+**GitHub specific methods**
-- [Method 5: Run as a GitHub App](INSTALL.md#method-5-run-as-a-github-app)
+- [Run as a GitHub Action](https://pr-agent-docs.codium.ai/installation/github/#run-as-a-github-action)
-  - Allowing you to automate the review process on your private or public repositories
+- [Run as a GitHub App](https://pr-agent-docs.codium.ai/installation/github/#run-as-a-github-app)
-- [Method 6: Deploy as a Lambda Function](INSTALL.md#method-6---deploy-as-a-lambda-function)
+
-- [Method 7: AWS CodeCommit](INSTALL.md#method-7---aws-codecommit-setup)
+**GitLab specific methods**
-- [Method 8: Run a GitLab webhook server](INSTALL.md#method-8---run-a-gitlab-webhook-server)
+- [Run a GitLab webhook server](https://pr-agent-docs.codium.ai/installation/gitlab/)
-- [Method 9: Run as a Bitbucket Pipeline](INSTALL.md#method-9-run-as-a-bitbucket-pipeline)
+
+**BitBucket specific methods**
+- [Run as a Bitbucket Pipeline](https://pr-agent-docs.codium.ai/installation/bitbucket/)
+
+## PR-Agent Pro 💎
+[PR-Agent Pro](https://www.codium.ai/pricing/) is a hosted version of PR-Agent, provided by CodiumAI. It is available for a monthly fee, and provides the following benefits:
+1. **Fully managed** - We take care of everything for you - hosting, models, regular updates, and more. Installation is as simple as signing up and adding the PR-Agent app to your GitHub\BitBucket repo.
+2. **Improved privacy** - No data will be stored or used to train models. PR-Agent Pro will employ zero data retention, and will use an OpenAI account with zero data retention.
+3. **Improved support** - PR-Agent Pro users will receive priority support, and will be able to request new features and capabilities.
+4. **Extra features** -In addition to the benefits listed above, PR-Agent Pro will emphasize more customization, and the usage of static code analysis, in addition to LLM logic, to improve results. 
+See [here](https://pr-agent-docs.codium.ai/#pr-agent-pro) for a list of features available in PR-Agent Pro.
+
+
 
 ## How it works
 
@@ -181,54 +263,26 @@ The following diagram illustrates PR-Agent tools and their flow:
 
 ![PR-Agent Tools](https://codium.ai/images/pr_agent/diagram-v0.9.png)
 
-Check out the [PR Compression strategy](./PR_COMPRESSION.md) page for more details on how we convert a code diff to a manageable LLM prompt
+Check out the [PR Compression strategy](https://pr-agent-docs.codium.ai/core-abilities/#pr-compression-strategy) page for more details on how we convert a code diff to a manageable LLM prompt
 
 ## Why use PR-Agent?
 
-A reasonable question that can be asked is: `"Why use PR-Agent? What make it stand out from existing tools?"`
+A reasonable question that can be asked is: `"Why use PR-Agent? What makes it stand out from existing tools?"`
 
 Here are some advantages of PR-Agent:
 
 - We emphasize **real-life practical usage**. Each tool (review, improve, ask, ...) has a single GPT-4 call, no more. We feel that this is critical for realistic team usage - obtaining an answer quickly (~30 seconds) and affordably.
-- Our [PR Compression strategy](./PR_COMPRESSION.md)  is a core ability that enables to effectively tackle both short and long PRs.
+- Our [PR Compression strategy](https://pr-agent-docs.codium.ai/core-abilities/#pr-compression-strategy)  is a core ability that enables to effectively tackle both short and long PRs.
 - Our JSON prompting strategy enables to have **modular, customizable tools**. For example, the '/review' tool categories can be controlled via the [configuration](pr_agent/settings/configuration.toml) file. Adding additional categories is easy and accessible.
-- We support **multiple git providers** (GitHub, Gitlab, Bitbucket, CodeCommit), **multiple ways** to use the tool (CLI, GitHub Action, GitHub App, Docker, ...), and **multiple models** (GPT-4, GPT-3.5, Anthropic, Cohere, Llama2).
+- We support **multiple git providers** (GitHub, Gitlab, Bitbucket), **multiple ways** to use the tool (CLI, GitHub Action, GitHub App, Docker, ...), and **multiple models** (GPT-4, GPT-3.5, Anthropic, Cohere, Llama2).
-- We are open-source, and welcome contributions from the community.
 
 
-## Roadmap
+## Data privacy
 
-- [x] Support additional models, as a replacement for OpenAI (see [here](https://github.com/Codium-ai/pr-agent/pull/172))
+If you host PR-Agent with your OpenAI API key, it is between you and OpenAI. You can read their API data privacy policy here:
-- [x] Develop additional logic for handling large PRs (see [here](https://github.com/Codium-ai/pr-agent/pull/229))
-- [ ] Add additional context to the prompt. For example, repo (or relevant files) summarization, with tools such a [ctags](https://github.com/universal-ctags/ctags)
-- [x] PR-Agent for issues
-- [ ] Adding more tools. Possible directions:
-  - [x] PR description
-  - [x] Inline code suggestions
-  - [x] Reflect and review
-  - [x] Rank the PR (see [here](https://github.com/Codium-ai/pr-agent/pull/89))   
-  - [ ] Enforcing CONTRIBUTING.md guidelines
-  - [ ] Performance (are there any performance issues)
-  - [x] Documentation (is the PR properly documented)
-  - [ ] ...
-
-See the [Release notes](./RELEASE_NOTES.md) for updates on the latest changes.
-
-
-## Similar Projects
-
-- [CodiumAI - Meaningful tests for busy devs](https://github.com/Codium-ai/codiumai-vscode-release) (although various capabilities are much more advanced in the CodiumAI IDE plugins)
-- [Aider - GPT powered coding in your terminal](https://github.com/paul-gauthier/aider)
-- [openai-pr-reviewer](https://github.com/coderabbitai/openai-pr-reviewer)
-- [CodeReview BOT](https://github.com/anc95/ChatGPT-CodeReview)
-- [AI-Maintainer](https://github.com/merwanehamadi/AI-Maintainer)
-
-## Data Privacy
-
-If you use a self-hosted PR-Agent with your OpenAI API key, it is between you and OpenAI. You can read their API data privacy policy here:
 https://openai.com/enterprise-privacy
 
-When using a PR-Agent app hosted by CodiumAI, we will not store any of your data, nor will we used it for training.
+When using PR-Agent Pro 💎, hosted by CodiumAI, we will not store any of your data, nor will we use it for training.
 You will also benefit from an OpenAI account with zero data retention.
 
 ## Links

Usage.md

@@ -1,419 +0,0 @@
-## Usage Guide
-
-### Table of Contents
-- [Introduction](#introduction)
-- [Working from a local repo (CLI)](#working-from-a-local-repo-cli)
-- [Online usage](#online-usage)
-- [Working with GitHub App](#working-with-github-app)
-- [Working with GitHub Action](#working-with-github-action)
-- [Working with BitBucket App](#working-with-bitbucket-self-hosted-app)
-- [Changing a model](#changing-a-model)
-- [Working with large PRs](#working-with-large-prs)
-- [Appendix - additional configurations walkthrough](#appendix---additional-configurations-walkthrough)
-
-### Introduction
-
-After [installation](/INSTALL.md), there are three basic ways to invoke CodiumAI PR-Agent:
-1. Locally running a CLI command
-2. Online usage - by [commenting](https://github.com/Codium-ai/pr-agent/pull/229#issuecomment-1695021901) on a PR
-3. Enabling PR-Agent tools to run automatically when a new PR is opened
-
-
-Specifically, CLI commands can be issued by invoking a pre-built [docker image](/INSTALL.md#running-from-source), or by invoking a [locally cloned repo](INSTALL.md#method-2-run-from-source).
-For online usage, you will need to setup either a [GitHub App](INSTALL.md#method-5-run-as-a-github-app), or a [GitHub Action](INSTALL.md#method-3-run-as-a-github-action).
-GitHub App and GitHub Action also enable to run PR-Agent specific tool automatically when a new PR is opened.
-
-
-#### The configuration file
-The different tools and sub-tools used by CodiumAI PR-Agent are adjustable via the **[configuration file](pr_agent/settings/configuration.toml)**.
-In addition to general configuration options, each tool has its own configurations. For example, the `review` tool will use parameters from the [pr_reviewer](/pr_agent/settings/configuration.toml#L16) section in the configuration file.
-
-The [Tools Guide](./docs/TOOLS_GUIDE.md) provides a detailed description of the different tools and their configurations.
-
-#### Ignoring files from analysis
-In some cases, you may want to exclude specific files or directories from the analysis performed by CodiumAI PR-Agent. This can be useful, for example, when you have files that are generated automatically or files that shouldn't be reviewed, like vendored code.
-
-To ignore files or directories, edit the **[ignore.toml](/pr_agent/settings/ignore.toml)** configuration file. This setting also exposes the following environment variables:
-
- - `IGNORE.GLOB`
- - `IGNORE.REGEX`
-
-For example, to ignore python files in a PR with online usage, comment on a PR:
-`/review --ignore.glob=['*.py']`
-
-To ignore python files in all PRs, set in a configuration file:
-```
-[ignore]
-glob = ['*.py']
-```
-
-#### git provider
-The [git_provider](pr_agent/settings/configuration.toml#L4) field in the configuration file determines the GIT provider that will be used by PR-Agent. Currently, the following providers are supported:
-`
-"github", "gitlab", "azure", "codecommit", "local", "gerrit"
-`
-
-[//]: # (** online usage:**)
-
-[//]: # (Options that are available in the configuration file can be specified at run time when calling actions. Two examples:)
-
-[//]: # (```)
-
-[//]: # (- /review --pr_reviewer.extra_instructions="focus on the file: ...")
-
-[//]: # (- /describe --pr_description.add_original_user_description=false -pr_description.extra_instructions="make sure to mention: ...")
-
-[//]: # (```)
-
-### Working from a local repo (CLI)
-When running from your local repo (CLI), your local configuration file will be used.
-Examples of invoking the different tools via the CLI:
-
-- **Review**:       `python -m pr_agent.cli --pr_url=<pr_url>  review`
-- **Describe**:     `python -m pr_agent.cli --pr_url=<pr_url>  describe`
-- **Improve**:      `python -m pr_agent.cli --pr_url=<pr_url>  improve`
-- **Ask**:          `python -m pr_agent.cli --pr_url=<pr_url>  ask "Write me a poem about this PR"`
-- **Reflect**:      `python -m pr_agent.cli --pr_url=<pr_url>  reflect`
-- **Update Changelog**:      `python -m pr_agent.cli --pr_url=<pr_url>  update_changelog`
-
-`<pr_url>` is the url of the relevant PR (for example: https://github.com/Codium-ai/pr-agent/pull/50).
-
-**Notes:**
-
-(1) in addition to editing your local configuration file, you can also change any configuration value by adding it to the command line:
-```
-python -m pr_agent.cli --pr_url=<pr_url>  /review --pr_reviewer.extra_instructions="focus on the file: ..."
-```
-
-(2) You can print results locally, without publishing them, by setting in `configuration.toml`:
-```
-[config]
-publish_output=true
-verbosity_level=2
-```
-This is useful for debugging or experimenting with different tools.
-
-
-### Online usage
-
-Online usage means invoking PR-Agent tools by [comments](https://github.com/Codium-ai/pr-agent/pull/229#issuecomment-1695021901) on a PR.
-Commands for invoking the different tools via comments:
-
-- **Review**:       `/review`
-- **Describe**:     `/describe`
-- **Improve**:      `/improve`
-- **Ask**:          `/ask "..."`
-- **Reflect**:      `/reflect`
-- **Update Changelog**:      `/update_changelog`
-
-
-To edit a specific configuration value, just add `--config_path=<value>` to any command.
-For example, if you want to edit the `review` tool configurations, you can run:
-```
-/review --pr_reviewer.extra_instructions="..." --pr_reviewer.require_score_review=false
-```
-Any configuration value in [configuration file](pr_agent/settings/configuration.toml) file can be similarly edited. Comment `/config` to see the list of available configurations.
-
-
-### Working with GitHub App
-When running PR-Agent from GitHub App, the default [configuration file](pr_agent/settings/configuration.toml) from a pre-built docker will be initially loaded.
-
-By uploading a local `.pr_agent.toml` file to the root of the repo's main branch, you can edit and customize any configuration parameter. Note that you need to upload `.pr_agent.toml` prior to creating a PR, in order for the configuration to take effect.
-
-For example, if you set in `.pr_agent.toml`:
-
-```
-[pr_reviewer]
-num_code_suggestions=1
-```
-
-Then you will overwrite the default number of code suggestions to 1.
-
-#### GitHub app automatic tools
-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
-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]
-handle_pr_actions = ['opened', 'reopened', 'ready_for_review', 'review_requested']
-pr_commands = [
-    "/describe --pr_description.add_original_user_description=true --pr_description.keep_original_user_title=true",
-    "/auto_review",
-]
-```
-This means that when a new PR is opened/reopened or marked as ready for review, PR-Agent will run the `describe` and `auto_review` tools.  
-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.
-For example, if your local `.pr_agent.toml` file contains:
-```
-[pr_description]
-add_original_user_description = false
-keep_original_user_title = false
-```
-When a new PR is opened, PR-Agent will run the `describe` tool with the above parameters.
-
-To cancel the automatic run of all the tools, set:
-```
-[github_app]
-handle_pr_actions = []
-```
-
-##### 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.
-
-The configuration toggle `handle_push_trigger` can be used to enable this feature.  
-The configuration parameter `push_commands` defines the list of tools that will be **run automatically** when new code is pushed to the PR.
-```
-[github_app]
-handle_push_trigger = true
-push_commands = [
-    "/describe --pr_description.add_original_user_description=true --pr_description.keep_original_user_title=true",
-    "/auto_review -i --pr_reviewer.remove_previous_review_comment=true",
-]
-```
-This means that when new code is pushed to the PR, the PR-Agent will run the `describe` and incremental `auto_review` tools.  
-For the describe tool, the `add_original_user_description` and `keep_original_user_title` parameters will be set to true.  
-For the `auto_review` tool, it will run in incremental mode, and the `remove_previous_review_comment` parameter will be set to true.
-
-Much like the configurations for `pr_commands`, you can override the default tool parameters by uploading a local configuration file to the root of your repo.
-
-#### Editing the prompts
-The prompts for the various PR-Agent tools are defined in the `pr_agent/settings` folder.
-In practice, the prompts are loaded and stored as a standard setting object.
-Hence, editing them is similar to editing any other configuration value - just place the relevant key in `.pr_agent.toml`file, and override the default value.
-
-For example, if you want to edit the prompts of the [describe](./pr_agent/settings/pr_description_prompts.toml) tool, you can add the following to your `.pr_agent.toml` file:
-```
-[pr_description_prompt]
-system="""
-...
-"""
-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).
-
-### Working with GitHub Action
-You can configure settings in 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:
-```yaml
-      env:
-        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_action.auto_review: "true" # enable\disable auto review
-        github_action.auto_describe: "true" # enable\disable auto describe
-        github_action.auto_improve: "false" # enable\disable auto improve
-```
-`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 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.
-
-For example, you can set an environment variable: `pr_description.add_original_user_description=false`, or add a `.pr_agent.toml` file with the following content:
-```
-[pr_description]
-add_original_user_description = false
-```
-
-### Working with BitBucket Self-Hosted App
-Similar to GitHub app, when running PR-Agent from BitBucket App, the default [configuration file](pr_agent/settings/configuration.toml) from a pre-built docker will be initially loaded.
-
-By uploading a local `.pr_agent.toml` file to the root of the repo's main branch, you can edit and customize any configuration parameter. Note that you need to upload `.pr_agent.toml` prior to creating a PR, in order for the configuration to take effect.
-
-For example, if your local `.pr_agent.toml` file contains:
-```
-[pr_reviewer]
-inline_code_comments = true
-```
-
-Each time you invoke a `/review` tool, it will use inline code comments.
-
-### Changing a model
-
-See [here](pr_agent/algo/__init__.py) for the list of available models.
-To use a different model than the default (GPT-4), you need to edit [configuration file](pr_agent/settings/configuration.toml#L2).
-For models and environments not from OPENAI, you might need to provide additional keys and other parameters. See below for instructions.
-
-#### Azure
-To use Azure, set in your `.secrets.toml` (working from CLI), or in the GitHub `Settings > Secrets and variables` (working from GitHub App or GitHub Action):
-```
-api_key = "" # your azure api key
-api_type = "azure"
-api_version = '2023-05-15'  # Check Azure documentation for the current API version
-api_base = ""  # The base URL for your Azure OpenAI resource. e.g. "https://<your resource name>.openai.azure.com"
-openai.deployment_id = ""  # The deployment name you chose when you deployed the engine
-```
-
-and set in your configuration file:
-```
-[config]
-model="" # the OpenAI model you've deployed on Azure (e.g. gpt-3.5-turbo)
-```
-
-#### Huggingface
-
-**Local**
-You can run Huggingface models locally through either [VLLM](https://docs.litellm.ai/docs/providers/vllm) or [Ollama](https://docs.litellm.ai/docs/providers/ollama)
-
-E.g. to use a new Huggingface model locally via Ollama, set:
-```
-[__init__.py]
-MAX_TOKENS = {
-    "model-name-on-ollama": <max_tokens>
-}
-e.g.
-MAX_TOKENS={
-    ...,
-    "ollama/llama2": 4096
-}
-
-
-[config] # in configuration.toml
-model = "ollama/llama2"
-
-[ollama] # in .secrets.toml
-api_base = ... # the base url for your huggingface inference endpoint
-# e.g. if running Ollama locally, you may use:
-api_base = "http://localhost:11434/"
-```
-
-**Inference Endpoints**
-
-To use a new model with Huggingface Inference Endpoints, for example, set:
-```
-[__init__.py]
-MAX_TOKENS = {
-    "model-name-on-huggingface": <max_tokens>
-}
-e.g.
-MAX_TOKENS={
-    ...,
-    "meta-llama/Llama-2-7b-chat-hf": 4096
-}
-[config] # in configuration.toml
-model = "huggingface/meta-llama/Llama-2-7b-chat-hf"
-
-[huggingface] # in .secrets.toml
-key = ... # your huggingface api key
-api_base = ... # the base url for your huggingface inference endpoint
-```
-(you can obtain a Llama2 key from [here](https://replicate.com/replicate/llama-2-70b-chat/api))
-
-#### Replicate
-
-To use Llama2 model with Replicate, for example, set:
-```
-[config] # in configuration.toml
-model = "replicate/llama-2-70b-chat:2c1608e18606fad2812020dc541930f2d0495ce32eee50074220b87300bc16e1"
-[replicate] # in .secrets.toml
-key = ...
-```
-(you can obtain a Llama2 key from [here](https://replicate.com/replicate/llama-2-70b-chat/api))
-
-
-Also review the [AiHandler](pr_agent/algo/ai_handler.py) file for instruction how to set keys for other models.
-
-#### Vertex AI
-
-To use Google's Vertex AI platform and its associated models (chat-bison/codechat-bison) set:
-
-``` 
-[config] # in configuration.toml
-model = "vertex_ai/codechat-bison"
-fallback_models="vertex_ai/codechat-bison"
-
-[vertexai] # in .secrets.toml
-vertex_project = "my-google-cloud-project"
-vertex_location = ""
-```
-
-Your [application default credentials](https://cloud.google.com/docs/authentication/application-default-credentials) will be used for authentication so there is no need to set explicit credentials in most environments.
-
-If you do want to set explicit credentials then you can use the `GOOGLE_APPLICATION_CREDENTIALS` environment variable set to a path to a json credentials file.
-
-#### Amazon Bedrock
-
-To use Amazon Bedrock and its foundational models, add the below configuration:
-
-``` 
-[config] # in configuration.toml
-model = "anthropic.claude-v2"
-fallback_models="anthropic.claude-instant-v1"
-
-[aws] # in .secrets.toml
-bedrock_region = "us-east-1"
-```
-
-Note that you have to add access to foundational models before using them. Please refer to [this document](https://docs.aws.amazon.com/bedrock/latest/userguide/setting-up.html) for more details.
-
-AWS session is automatically authenticated from your environment, but you can also explicitly set `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY` environment variables.
-
-### Working with large PRs
-
-The default mode of CodiumAI is to have a single call per tool, using GPT-4, which has a token limit of 8000 tokens.
-This mode provide a very good speed-quality-cost tradeoff, and can handle most PRs successfully.
-When the PR is above the token limit, it employs a [PR Compression strategy](./PR_COMPRESSION.md).
-
-However, for very large PRs, or in case you want to emphasize quality over speed and cost, there are 2 possible solutions:
-1) [Use a model](#changing-a-model) with larger context, like GPT-32K, or claude-100K. This solution will be applicable for all the tools.
-2) For the `/improve` tool, there is an ['extended' mode](./docs/IMPROVE.md) (`/improve --extended`),
-which divides the PR to chunks, and process each chunk separately. With this mode, regardless of the model, no compression will be done (but for large PRs, multiple model calls may occur)
-
-### Appendix - additional configurations walkthrough
-
-
-#### Extra instructions
-All PR-Agent tools have a parameter called `extra_instructions`, that enables to add free-text extra instructions. Example usage:
-```
-/update_changelog --pr_update_changelog.extra_instructions="Make sure to update also the version ..."
-```
-
-#### Patch Extra Lines
-By default, around any change in your PR, git patch provides 3 lines of context above and below the change.
-```
-@@ -12,5 +12,5 @@ def func1():
- code line that already existed in the file...
- code line that already existed in the file...
- code line that already existed in the file....
--code line that was removed in the PR
-+new code line added in the PR
- code line that already existed in the file...
- code line that already existed in the file...
- code line that already existed in the file...
-```
-
-For the `review`, `describe`, `ask` and `add_docs` tools, if the token budget allows, PR-Agent tries to increase the number of lines of context, via the parameter:
-```
-[config]
-patch_extra_lines=3
-```
-
-Increasing this number provides more context to the model, but will also increase the token budget.
-If the PR is too large (see [PR Compression strategy](./PR_COMPRESSION.md)), PR-Agent automatically sets this number to 0, using the original git patch.
-
-
-#### Azure DevOps provider
-To use Azure DevOps provider use the following settings in configuration.toml:
-```
-[config]
-git_provider="azure"
-use_repo_settings_file=false
-```
-
-And use the following settings (you have to replace the values) in .secrets.toml:
-```
-[azure_devops]
-org = "https://dev.azure.com/YOUR_ORGANIZATION/"
-pat = "YOUR_PAT_TOKEN"
-```

docker/Dockerfile

@@ -26,6 +26,10 @@ FROM base as gitlab_webhook
 ADD pr_agent pr_agent
 CMD ["python", "pr_agent/servers/gitlab_webhook.py"]
 
+FROM base as azure_devops_webhook
+ADD pr_agent pr_agent
+CMD ["python", "pr_agent/servers/azuredevops_server_webhook.py"]
+
 FROM base as test
 ADD requirements-dev.txt .
 RUN pip install -r requirements-dev.txt && rm requirements-dev.txt

docs/ADD_DOCUMENTATION.md

@@ -1,15 +0,0 @@
-# Add Documentation Tool
-The `add_docs` tool scans the PR code changes, and automatically suggests documentation for the undocumented code components (functions, classes, etc.).
-
-It can be invoked manually by commenting on any PR:
-```
-/add_docs
-```
-For example:
-
-<kbd><img src=https://codium.ai/images/pr_agent/add_docs_comment.png width="768"></kbd>
-<kbd><img src=https://codium.ai/images/pr_agent/add_docs.png width="768"></kbd>
-
-### Configuration options
- - `docs_style`: The exact style of the documentation (for python docstring). you can choose between: `google`, `numpy`, `sphinx`, `restructuredtext`, `plain`. Default is `sphinx`.
- - `extra_instructions`: Optional extra instructions to the tool. For example: "focus on the changes in the file X. Ignore change in ...".

docs/ASK.md

@@ -1,11 +0,0 @@
-# ASK Tool
-
-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 "..."
-```
-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>

docs/DESCRIBE.md

@@ -1,70 +0,0 @@
-# Describe Tool
-
-The `describe` tool scans the PR code changes, and automatically generates PR description - title, type, summary, walkthrough and labels.
-It can be invoked manually by commenting on any PR:
-```
-/describe
-```
-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.png width="768"></kbd>
-
-The `describe` tool can also be triggered automatically every time a new PR is opened. See examples for automatic triggers for [GitHub App](https://github.com/Codium-ai/pr-agent/blob/main/Usage.md#github-app-automatic-tools) and [GitHub Action](https://github.com/Codium-ai/pr-agent/blob/main/Usage.md#working-with-github-action)
-
-### Configuration options
-
-Under the section 'pr_description', the [configuration file](./../pr_agent/settings/configuration.toml#L28) contains options to customize the 'describe' tool:
-
-- `publish_labels`: if set to true, the tool will publish the labels to the PR. Default is true.
-
-- `publish_description_as_comment`: if set to true, the tool will publish the description as a comment to the PR. If false, it will overwrite the origianl description. Default is false.
-
-- `add_original_user_description`: if set to true, the tool will add the original user description to the generated description. Default is false.
-
-- `keep_original_user_title`: if set to true, the tool will keep the original PR title, and won't change it. Default is false.
-
-- `extra_instructions`: Optional extra instructions to the tool. For example: "focus on the changes in the file X. Ignore change in ...".
-
-- To enable `custom labels`, apply the configuration changes described [here](./GENERATE_CUSTOM_LABELS.md#configuration-changes)
-
-- `enable_pr_type`: if set to false, it will not show the `PR type` as a text value in the description content. Default is true.
-
-- `final_update_message`: if set to true, it will add a comment message [`PR Description updated to latest commit...`](https://github.com/Codium-ai/pr-agent/pull/499#issuecomment-1837412176) after finishing calling `/describe`. Default is true.
-
-- `enable_semantic_files_types`: if set to true, "PR changes walkthrough" section will be generated. Default is true.
-  
-### Markers template
-
-markers enable to easily integrate user's content and auto-generated content, with a template-like mechanism.
-
-For example, if the PR original description was:
-```
-User content...
-
-
-## PR Description:
-pr_agent:summary
-
-## PR Walkthrough:
-pr_agent:walkthrough
-```
-The marker `pr_agent:summary` will be replaced with the PR summary, and `pr_agent:walkthrough` will be replaced with the PR walkthrough.
-
-##### Example:
-```
-        env:
-          pr_description.use_description_markers: 'true'
-```          
-
-<kbd><img src=https://codium.ai/images/pr_agent/describe_markers_before.png width="768"></kbd>
-
-==>
-
-<kbd><img src=https://codium.ai/images/pr_agent/describe_markers_after.png width="768"></kbd>
-
-##### Configuration params:
-
-- `use_description_markers`: if set to true, the tool will use markers template. It replaces every marker of the form `pr_agent:marker_name` with the relevant content. Default is false.
-- `include_generated_by_header`: if set to true, the tool will add a dedicated header: 'Generated by PR Agent at ...' to any automatic content. Default is true.

docs/GENERATE_CUSTOM_LABELS.md

@@ -1,41 +0,0 @@
-# Generate Custom Labels
-The `generate_labels` tool scans the PR code changes, and given a list of labels and their descriptions, it automatically suggests labels that match the PR code changes.
-
-It can be invoked manually by commenting on any PR:
-```
-/generate_labels
-```
-For example:
-
-If we wish to add detect changes to SQL queries in a given PR, we can add the following custom label along with its description:
-
-<kbd><img src=https://codium.ai/images/pr_agent/custom_labels_list.png width="768"></kbd>
-
-When running the `generate_labels` tool on a PR that includes changes in SQL queries, it will automatically suggest the custom label:
-<kbd><img src=https://codium.ai/images/pr_agent/custom_label_published.png width="768"></kbd>
-
-### How to enable custom labels
-
-Note that in addition to the dedicated tool `generate_labels`, the custom labels will also be used by the `review` and `describe` tools.
-
-#### CLI
-To enable custom labels, you need to apply the [configuration changes](#configuration-changes) to the [custom_labels file](./../pr_agent/settings/custom_labels.toml):
-
-#### GitHub Action and GitHub App
-To enable custom labels, you need to apply the [configuration changes](#configuration-changes) to the local `.pr_agent.toml` file in you repository.
-
-#### Configuration changes
- - Change `enable_custom_labels` to True: This will turn off the default labels and enable the custom labels provided in the custom_labels.toml file.
- - Add the custom labels. It should be formatted as follows:
-
-```
-[config]
-enable_custom_labels=true
-
-[custom_labels."Custom Label Name"]
-description = "Description of when AI should suggest this label"
-
-[custom_labels."Custom Label 2"]
-description = "Description of when AI should suggest this label 2"
-```
-

docs/IMPROVE.md

@@ -1,57 +0,0 @@
-# Improve Tool
-
-The `improve` tool scans the PR code changes, and automatically generates committable suggestions for improving the PR code.
-It can be invoked manually by commenting on any PR:
-```
-/improve
-```
-For example:
-
-<kbd><img src=https://codium.ai/images/pr_agent/improve_comment.png width="768"></kbd>
-<kbd><img src=https://codium.ai/images/pr_agent/improve.png width="768"></kbd>
-
-The `improve` tool can also be triggered automatically every time a new PR is opened. See examples for automatic triggers for [GitHub App](https://github.com/Codium-ai/pr-agent/blob/main/Usage.md#github-app-automatic-tools) and [GitHub Action](https://github.com/Codium-ai/pr-agent/blob/main/Usage.md#working-with-github-action)
-
-An extended mode, which does not involve PR Compression and provides more comprehensive suggestions, can be invoked by commenting on any PR:
-```
-/improve --extended
-```
-Note that the extended mode divides the PR code changes into chunks, up to the token limits, where each chunk is handled separately (multiple calls to GPT-4).
-Hence, the total number of suggestions is proportional to the number of chunks, i.e., the size of the PR.
-
-### Configuration options
-
-Under the section 'pr_code_suggestions', the [configuration file](./../pr_agent/settings/configuration.toml#L40) contains options to customize the 'improve' tool:
-
-- `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 ...".
-- `rank_suggestions`: if set to true, the tool will rank the suggestions, based on importance. Default is false.
-
-#### params for '/improve --extended' mode
-- `num_code_suggestions_per_chunk`: number of code suggestions provided by the 'improve' tool, per chunk. Default is 8.
-- `rank_extended_suggestions`: if set to true, the tool will rank the suggestions, based on importance. Default is true.
-- `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.
-
-#### summarize mode
-- `summarize`: if set to true, the tool will present the code suggestions in a compact way. Default is false.
-
-In this mode, instead of presenting committable suggestions, the different suggestions will be combined into a single compact comment, with significantly smaller PR footprint.
-
-For example:
-
-`/improve --pr_code_suggestions.summarize=true`
-
-<kbd><img src=https://codium.ai/images/pr_agent/improved_summerize_open.png width="768"></kbd>
-
-___
-
-### 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.
-
-- Suggestions are not meant to be [simplistic](./../pr_agent/settings/pr_code_suggestions_prompts.toml#L34). 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.
-
-- Best quality will be obtained by using 'improve --extended' mode.

docs/README.md

@@ -0,0 +1,15 @@
+# To install:
+pip install mkdocs
+pip install mkdocs-material
+pip install mkdocs-material-extensions
+pip install "mkdocs-material[imaging]"
+
+# docs
+To run localy: `mkdocs serve`
+
+To expand and customize the theme: [Material MKDocs](https://squidfunk.github.io/mkdocs-material/)
+
+The deployment is managed on the gh-pages branches.
+After each merge to main the deplloyment will be taken care of by GH action automatically and the new version will be available at: [Docs](https://codium-ai.github.io/docs/)
+
+Github action is located in `.github/workflows/ci.yml` file.

docs/REVIEW.md

@@ -1,79 +0,0 @@
-# Review Tool
-
-The `review` tool scans the PR code changes, and automatically generates a PR review.
-It can be invoked manually by commenting on any PR:
-```
-/review
-```
-For example:
-
-<kbd><img src=https://codium.ai/images/pr_agent/review_comment.png width="768"></kbd>
-<kbd><img src=https://codium.ai/images/pr_agent/review.png width="768"></kbd>
-
-The `review` tool can also be triggered automatically every time a new PR is opened. See examples for automatic triggers for [GitHub App](https://github.com/Codium-ai/pr-agent/blob/main/Usage.md#github-app-automatic-tools) and [GitHub Action](https://github.com/Codium-ai/pr-agent/blob/main/Usage.md#working-with-github-action)
-
-### Configuration options
-
-Under the section 'pr_reviewer', the [configuration file](./../pr_agent/settings/configuration.toml#L16) contains options to customize the 'review' tool:
-
-#### enable\\disable features
-- `require_focused_review`: if set to true, the tool will add a section - 'is the PR a focused one'. 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_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 thed effort needed to review the PR. Default is true.
-#### general options
-- `num_code_suggestions`: number of code suggestions provided by the 'review' tool. Default is 4.
-- `inline_code_comments`: if set to true, the tool will publish the code suggestions as comments on the code diff. Default is false.
-- `automatic_review`: if set to false, no automatic reviews will be done. Default is true.
-- `remove_previous_review_comment`: if set to true, the tool will remove the previous review comment before adding a new one. Default is false.
-- `persistent_comment`: if set to true, the review comment will be persistent, meaning that every new review request will edit the previous one. Default is true.
-- `extra_instructions`: Optional extra instructions to the tool. For example: "focus on the changes in the file X. Ignore change in ...".
-#### review 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_effort`: if set to true, the tool will publish a 'Review effort [1-5]: x' label. Default is false.
-- To enable `custom labels`, apply the configuration changes described [here](./GENERATE_CUSTOM_LABELS.md#configuration-changes) 
-####  Incremental Mode
-For an incremental review, which 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, the following command can be used:
-```
-/review -i
-```
-Note that the incremental mode is only available for GitHub.
-
-<kbd><img src=https://codium.ai/images/pr_agent/incremental_review.png width="768"></kbd>
-
-Under the section 'pr_reviewer', the [configuration file](./../pr_agent/settings/configuration.toml#L16) contains options to customize the 'review -i' tool.  
-These configurations can be used to control the rate at which the incremental review tool will create new review comments when invoked automatically, to prevent making too much noise in the PR.
-- `minimal_commits_for_incremental_review`: Minimal number of commits since the last review that are required to create incremental review.
-If there are less than the specified number of commits since the last review, the tool will not perform any action.
-Default is 0 - the tool will always run, no matter how many commits since the last review.
-- `minimal_minutes_for_incremental_review`: Minimal number of minutes that need to pass since the last reviewed commit to create incremental review.
-If less that the specified number of minutes have passed between the last reviewed commit and running this command, the tool will not perform any action. 
-Default is 0 - the tool will always run, no matter how much time have passed since the last reviewed commit.
-- `require_all_thresholds_for_incremental_review`: If set to true, all the previous thresholds must be met for incremental review to run. If false, only one is enough to run the tool.
-For example, if `minimal_commits_for_incremental_review=2` and `minimal_minutes_for_incremental_review=2`, and we have 3 commits since the last review, but the last reviewed commit is from 1 minute ago:
-When `require_all_thresholds_for_incremental_review=true` the incremental review __will not__ run, because only 1 out of 2 conditions were met (we have enough commits but the last review is too recent),
-but when `require_all_thresholds_for_incremental_review=false` the incremental review __will__ run, because one condition is enough (we have 3 commits which is more than the configured 2).
-Default is false - the tool will run as long as at least once conditions is met.
-
-#### PR Reflection
-By invoking:
-```
-/reflect_and_review
-```
-The tool will first ask the author questions about the PR, and will guide the review based on his answers.
-
-<kbd><img src=https://codium.ai/images/pr_agent/reflection_questions.png width="768"></kbd>
-<kbd><img src=https://codium.ai/images/pr_agent/reflection_answers.png width="768"></kbd>
-<kbd><img src=https://codium.ai/images/pr_agent/reflection_insights.png width="768"></kbd>
-
-
-#### A note on code suggestions quality
-
-- With current level of AI for code (GPT-4), mistakes can happen. Not all the suggestions will be perfect, and a user should not accept all of them automatically.
-
-- Suggestions are not meant to be [simplistic](./../pr_agent/settings/pr_reviewer_prompts.toml#L29). 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.
-
-- Unlike the 'review' feature, which does a lot of things, the ['improve --extended'](./IMPROVE.md) feature is dedicated only to suggestions, and usually gives better results.

docs/TOOLS_GUIDE.md

@@ -1,11 +0,0 @@
-## Tools Guide
-- [DESCRIBE](./DESCRIBE.md)
-- [REVIEW](./REVIEW.md)
-- [IMPROVE](./IMPROVE.md)
-- [ASK](./ASK.md)
-- [SIMILAR_ISSUE](./SIMILAR_ISSUE.md)
-- [UPDATE CHANGELOG](./UPDATE_CHANGELOG.md)
-- [ADD DOCUMENTATION](./ADD_DOCUMENTATION.md)
-- [GENERATE CUSTOM LABELS](./GENERATE_CUSTOM_LABELS.md)
-
-See the **[installation guide](/INSTALL.md)** for instructions on how to setup PR-Agent.

docs/docs/CNAME

@@ -0,0 +1 @@
+pr-agent-docs.codium.ai

docs/docs/core-abilities/index.md

@@ -1,42 +1,52 @@
-# PR Compression Strategy
+## PR Compression Strategy
 There are two scenarios:
+
 1. The PR is small enough to fit in a single prompt (including system and user prompt)
 2. The PR is too large to fit in a single prompt (including system and user prompt)
 
 For both scenarios, we first use the following strategy
-#### Repo language prioritization strategy
 
+#### Repo language prioritization strategy
 We prioritize the languages of the repo based on the following criteria:
+
 1. Exclude binary files and non code files (e.g. images, pdfs, etc)
 2. Given the main languages used in the repo
-2. We sort the PR files by the most common languages in the repo (in descending order): 
+3. We sort the PR files by the most common languages in the repo (in descending order): 
    * ```[[file.py, file2.py],[file3.js, file4.jsx],[readme.md]]```
    
 
-## Small PR
+### Small PR
 In this case, we can fit the entire PR in a single prompt:
 1. Exclude binary files and non code files (e.g. images, pdfs, etc)
 2. We Expand the surrounding context of each patch to 3 lines above and below the patch
-## Large PR
 
-### Motivation
+### Large PR
+
+#### Motivation
 Pull Requests can be very long and contain a lot of information with varying degree of relevance to the pr-agent.
 We want to be able to pack as much information as possible in a single LMM prompt, while keeping the information relevant to the pr-agent.
 
-
-
 #### Compression strategy
 We prioritize additions over deletions:
  - Combine all deleted files into a single list (`deleted files`)
  - File patches are a list of hunks, remove all hunks of type deletion-only from the hunks in the file patch
+
 ####  Adaptive and token-aware file patch fitting
 We use [tiktoken](https://github.com/openai/tiktoken) to tokenize the patches after the modifications described above, and we use the following strategy to fit the patches into the prompt:
-1. Within each language we sort the files by the number of tokens in the file (in descending order):
-   * ```[[file2.py, file.py],[file4.jsx, file3.js],[readme.md]]```
-2. Iterate through the patches in the order described above
-2. Add the patches to the prompt until the prompt reaches a certain buffer from the max token length
-3. If there are still patches left, add the remaining patches as a list called `other modified files` to the prompt until the prompt reaches the max token length (hard stop), skip the rest of the patches.
-4. If we haven't reached the max token length, add the `deleted files` to the prompt until the prompt reaches the max token length (hard stop), skip the rest of the patches.
 
-### Example
+1. Within each language we sort the files by the number of tokens in the file (in descending order):
+    - ```[[file2.py, file.py],[file4.jsx, file3.js],[readme.md]]```
+2. Iterate through the patches in the order described above
+3. Add the patches to the prompt until the prompt reaches a certain buffer from the max token length
+4. If there are still patches left, add the remaining patches as a list called `other modified files` to the prompt until the prompt reaches the max token length (hard stop), skip the rest of the patches.
+5. If we haven't reached the max token length, add the `deleted files` to the prompt until the prompt reaches the max token length (hard stop), skip the rest of the patches.
+
+#### Example
+
 <kbd><img src=https://codium.ai/images/git_patch_logic.png width="768"></kbd>
+
+## YAML Prompting
+TBD
+
+## Static Code Analysis 💎
+TBD

docs/docs/css/custom.css

@@ -0,0 +1,98 @@
+
+
+:root {
+    --md-primary-fg-color: #765bfa;
+    --md-accent-fg-color: #AEA1F1;
+  }
+.md-nav__title, .md-nav__link  {
+    font-size: 16px; /* Adjust the font size as needed */
+}
+
+.md-tabs__link  {
+    font-size: 16px; /* Adjust the font size as needed */
+}
+
+.md-header__title {
+    font-size: 20px; /* Adjust the font size as needed */
+}
+
+/* 
+@media (prefers-color-scheme: light) {
+    body {
+        --md-primary-fg-color: #00ffee !important;
+        --md-primary-bg-color: #ff0000 !important;
+    }
+
+    body, .md-main, .md-content {
+        background-color: #4312f5 !important;
+    }
+}
+
+@media (prefers-color-scheme: dark) {
+    body {
+        --md-primary-fg-color: #171518 !important;
+        --md-primary-bg-color: #171518 !important;
+    }
+
+    body, .md-main, .md-content {
+        background-color: #171518 !important;
+    }
+
+    .md-header__title {
+        color: #ffffff !important;
+    }
+
+    .md-tabs .md-tabs__link {
+        color: #ffffff !important;
+    }
+
+    .md-tabs .md-tabs__link:hover,
+    .md-tabs .md-tabs__link:focus {
+        color: #ffffff !important; 
+    }
+
+    .md-header__button {
+        color: #ffffff !important; 
+    }
+
+    .md-header__button svg {
+        fill: currentColor !important; 
+    }
+
+    .md-header__button:hover,
+    .md-header__button:focus {
+        color: #ffffff !important; 
+    }
+
+    .md-header__button:hover svg,
+    .md-header__button:focus svg {
+        fill: currentColor !important;
+    }
+
+    .md-search__icon svg {
+        fill: #ffffff !important;
+    }
+
+    .md-search__input {
+        color: #ffffff !important;
+    }
+
+    .md-nav__item--active > .md-nav__link--active,
+    .md-nav__link--active {
+        color: #AEA1F1 !important;
+    }
+
+    .md-nav--secondary .md-nav__title {
+        background: #171518;
+        box-shadow: 0 0 0.4rem 0.4rem #171518;
+    }
+
+    .md-nav--lifted>.md-nav__list>.md-nav__item--active>.md-nav__link {
+        background: #171518;
+        box-shadow: 0 0 0.4rem 0.4rem #171518;
+    }
+
+    .md-content a {
+        color: #AEA1F1 !important;
+    }
+} */

docs/docs/index.md

@@ -0,0 +1,162 @@
+# Overview
+
+CodiumAI PR-Agent is an open-source tool to help efficiently review and handle pull requests.
+
+- See the [Installation Guide](./installation/index.md) for instructions on installing and running the tool on different git platforms.
+
+- See the [Usage Guide](./usage-guide/index.md) for instructions on running the PR-Agent commands via different interfaces, including _CLI_, _online usage_, or by _automatically triggering_ them when a new PR is opened.
+
+- See the [Tools Guide](./tools/index.md) for a detailed description of the different tools.
+
+
+## PR-Agent Features
+PR-Agent offers extensive pull request functionalities across various git providers.
+
+|       |                                                                                                                     | GitHub | Gitlab | Bitbucket | Azure DevOps |
+|-------|---------------------------------------------------------------------------------------------------------------------|:------:|:------:|:---------:|:------------:|
+| TOOLS | Review                                                                                                              |   ✔️    |   ✔️    |   ✔️       |      ✔️      |
+|       | ⮑ Incremental                                                                                                       |   ✔️    |        |            |              |
+|       | ⮑ [SOC2 Compliance](https://pr-agent-docs.codium.ai/tools/review/#soc2-ticket-compliance){:target="_blank"} 💎                                     |   ✔️    |   ✔️    |   ✔️        |      ✔️      |
+|       | Ask                                                                                                                 |   ✔️    |   ✔️    |   ✔️        |      ✔️      |
+|       | Describe                                                                                                            |   ✔️    |   ✔️    |   ✔️        |      ✔️      |
+|       | ⮑ [Inline file summary](https://pr-agent-docs.codium.ai/tools/describe/#inline-file-summary){:target="_blank"} 💎                                 |   ✔️    |   ✔️    |   ✔️        |      ✔️      |
+|       | Improve                                                                                                             |   ✔️    |   ✔️    |   ✔️        |      ✔️      |
+|       | ⮑ Extended                                                                                                          |   ✔️    |   ✔️    |   ✔️        |      ✔️      |
+|       | [Custom Suggestions](./tools/custom_suggestions.md){:target="_blank"} 💎                                               |   ✔️    |   ✔️    |   ✔️        |      ✔️      |
+|       | Reflect and Review                                                                                                  |   ✔️    |   ✔️    |   ✔️        |      ✔️      |
+|       | Update CHANGELOG.md                                                                                                 |   ✔️    |   ✔️    |   ✔️        |      ️       |
+|       | Find Similar Issue                                                                                                  |   ✔️    |        |             |      ️       |
+|       | [Add PR Documentation](./tools/documentation.md){:target="_blank"} 💎                                                  |   ✔️    |   ✔️    |   ✔️        |      ✔️      |
+|       | [Generate Custom Labels](./tools/describe.md#handle-custom-labels-from-the-repos-labels-page-💎){:target="_blank"} 💎 |   ✔️    |   ✔️    |            |      ✔️      |
+|       | [Analyze PR Components](./tools/analyze.md){:target="_blank"} 💎                                                       |   ✔️    |   ✔️    |   ✔️      |      ✔️      |
+|       |                                                                                                                     |        |        |            |      ️       |
+| USAGE | CLI                                                                                                                 |   ✔️    |   ✔️    |   ✔️       |      ✔️      |
+|       | App / webhook                                                                                                       |   ✔️    |   ✔️    |            |      ✔️      |
+|       | Tagging bot                                                                                                         |   ✔️    |        |            |      ✔️      |
+|       | Actions                                                                                                             |   ✔️    |        |            |      ️       |
+|       |                                                                                                                     |        |        |            |
+| CORE  | PR compression                                                                                                      |   ✔️    |   ✔️    |   ✔️       |   ✔️        |
+|       | Repo language prioritization                                                                                        |   ✔️    |   ✔️    |   ✔️       |   ✔️        |
+|       | Adaptive and token-aware file patch fitting                                                                         |   ✔️    |   ✔️    |   ✔️     |   ✔️        |
+|       | Multiple models support                                                                                             |   ✔️    |   ✔️    |   ✔️       |   ✔️        |
+|       | Incremental PR review                                                                                               |   ✔️    |        |            |           |
+|       | [Static code analysis](./tools/analyze.md/){:target="_blank"} 💎                                                        |   ✔️    |   ✔️     |    ✔️    |   ✔️        |
+|       | [Multiple configuration options](./usage-guide/configuration_options.md){:target="_blank"} 💎                           |   ✔️    |   ✔️     |    ✔️    |   ✔️        |
+
+💎 marks a feature available only in [PR-Agent Pro](https://www.codium.ai/pricing/){:target="_blank"}
+
+
+## Example results
+<hr>
+<h4><a href="https://github.com/Codium-ai/pr-agent/pull/530">/describe</a></h4>
+<div align="center">
+<p float="center">
+<img src="https://www.codium.ai/images/pr_agent/describe_new_short_main.png" width="512">
+</p>
+</div>
+<hr>
+
+<h4><a href="https://github.com/Codium-ai/pr-agent/pull/732#issuecomment-1975099151">/review</a></h4>
+<div align="center">
+<p float="center">
+<kbd>
+<img src="https://www.codium.ai/images/pr_agent/review_new_short_main.png" width="512">
+</kbd>
+</p>
+</div>
+<hr>
+
+<h4><a href="https://github.com/Codium-ai/pr-agent/pull/732#issuecomment-1975099159">/improve</a></h4>
+<div align="center">
+<p float="center">
+<kbd>
+<img src="https://www.codium.ai/images/pr_agent/improve_new_short_main.png" width="512">
+</kbd>
+</p>
+</div>
+<hr>
+
+<h4><a href="https://github.com/Codium-ai/pr-agent/pull/530">/generate_labels</a></h4>
+<div align="center">
+<p float="center">
+<kbd><img src="https://www.codium.ai/images/pr_agent/geneare_custom_labels_main_short.png" width="300"></kbd>
+</p>
+</div>
+
+[//]: # (<h4><a href="https://github.com/Codium-ai/pr-agent/pull/78#issuecomment-1639739496">/reflect_and_review:</a></h4>)
+
+[//]: # (<div align="center">)
+
+[//]: # (<p float="center">)
+
+[//]: # (<img src="https://www.codium.ai/images/reflect_and_review.gif" width="800">)
+
+[//]: # (</p>)
+
+[//]: # (</div>)
+
+[//]: # (<h4><a href="https://github.com/Codium-ai/pr-agent/pull/229#issuecomment-1695020538">/ask:</a></h4>)
+
+[//]: # (<div align="center">)
+
+[//]: # (<p float="center">)
+
+[//]: # (<img src="https://www.codium.ai/images/ask-2.gif" width="800">)
+
+[//]: # (</p>)
+
+[//]: # (</div>)
+
+[//]: # (<h4><a href="https://github.com/Codium-ai/pr-agent/pull/229#issuecomment-1695024952">/improve:</a></h4>)
+
+[//]: # (<div align="center">)
+
+[//]: # (<p float="center">)
+
+[//]: # (<img src="https://www.codium.ai/images/improve-2.gif" width="800">)
+
+[//]: # (</p>)
+
+[//]: # (</div>)
+<div align="left">
+
+
+</div>
+<hr>
+
+
+## How it works
+
+The following diagram illustrates PR-Agent tools and their flow:
+
+![PR-Agent Tools](https://codium.ai/images/pr_agent/diagram-v0.9.png)
+
+Check out the [PR Compression strategy](core-abilities/index.md) page for more details on how we convert a code diff to a manageable LLM prompt
+
+
+
+## PR-Agent Pro 💎
+
+[PR-Agent Pro](https://www.codium.ai/pricing/) is a hosted version of PR-Agent, provided by CodiumAI. It is available for a monthly fee, and provides the following benefits:
+
+1. **Fully managed** - We take care of everything for you - hosting, models, regular updates, and more. Installation is as simple as signing up and adding the PR-Agent app to your GitHub\BitBucket repo.
+2. **Improved privacy** - No data will be stored or used to train models. PR-Agent Pro will employ zero data retention, and will use an OpenAI account with zero data retention.
+3. **Improved support** - PR-Agent Pro users will receive priority support, and will be able to request new features and capabilities.
+4. **Extra features** -In addition to the benefits listed above, PR-Agent Pro will emphasize more customization, and the usage of static code analysis, in addition to LLM logic, to improve results. It has the following additional tools and features:
+    - [**Analyze PR components**](./tools/analyze.md/)
+    - [**Custom Code Suggestions**](./tools/custom_suggestions.md/)
+    - [**Tests**](./tools/test.md/)
+    - [**PR documentation**](./tools/documentation.md/)
+    - [**CI feedback**](./tools/ci_feedback.md/)
+    - [**SOC2 compliance check**](./tools/review.md/#soc2-ticket-compliance)
+    - [**Custom labels**](./tools/describe.md/#handle-custom-labels-from-the-repos-labels-page)
+    - [**Global and wiki configuration**](./usage-guide/configuration_options.md/#wiki-configuration-file)
+
+   
+## Data privacy
+
+If you host PR-Agent with your OpenAI API key, it is between you and OpenAI. You can read their API data privacy policy here:
+https://openai.com/enterprise-privacy
+
+When using PR-Agent Pro 💎, hosted by CodiumAI, we will not store any of your data, nor will we use it for training.
+You will also benefit from an OpenAI account with zero data retention.

docs/docs/installation/azure.md

@@ -0,0 +1,36 @@
+## Azure DevOps provider
+
+To use Azure DevOps provider use the following settings in configuration.toml:
+```
+[config]
+git_provider="azure"
+use_repo_settings_file=false
+```
+
+Azure DevOps provider supports [PAT token](https://learn.microsoft.com/en-us/azure/devops/organizations/accounts/use-personal-access-tokens-to-authenticate?view=azure-devops&tabs=Windows) or [DefaultAzureCredential](https://learn.microsoft.com/en-us/azure/developer/python/sdk/authentication-overview#authentication-in-server-environments) authentication.
+PAT is faster to create, but has build in experation date, and will use the user identity for API calls. 
+Using DefaultAzureCredential you can use managed identity or Service principle, which are more secure and will create seperate ADO user identity (via AAD) to the agent.
+
+If PAT was choosen, you can assign the value in .secrets.toml. 
+If DefaultAzureCredential was choosen, you can assigned the additional env vars like AZURE_CLIENT_SECRET directly, 
+or use managed identity/az cli (for local develpment) without any additional configuration.
+in any case, 'org' value must be assigned in .secrets.toml:
+```
+[azure_devops]
+org = "https://dev.azure.com/YOUR_ORGANIZATION/"
+# pat = "YOUR_PAT_TOKEN" needed only if using PAT for authentication
+```
+
+### Azure DevOps Webhook
+
+To trigger from an Azure webhook, you need to manually [add a webhook](https://learn.microsoft.com/en-us/azure/devops/service-hooks/services/webhooks?view=azure-devops). 
+Use the "Pull request created" type to trigger a review, or "Pull request commented on" to trigger any supported comment with /<command> <args> comment on the relevant PR. Note that for the "Pull request commented on" trigger, only API v2.0 is supported.
+
+
+For webhook security, create a sporadic username/password pair and configure the webhook username and password on both the server and Azure DevOps webhook. These will be sent as basic Auth data by the webhook with each request:
+```
+[azure_devops_server]
+webhook_username = "<basic auth user>"
+webhook_password = "<basic auth password>"
+```
+> :warning: **Ensure that the webhook endpoint is only accessible over HTTPS** to mitigate the risk of credential interception when using basic authentication.

docs/docs/installation/bitbucket.md

@@ -0,0 +1,70 @@
+## Run as a Bitbucket Pipeline
+
+
+You can use the Bitbucket Pipeline system to run PR-Agent on every pull request open or update.
+
+1. Add the following file in your repository bitbucket_pipelines.yml
+
+```yaml
+pipelines:
+    pull-requests:
+      '**':
+        - step:
+            name: PR Agent Review
+            image: python:3.10
+            services:
+              - docker
+            script:
+              - docker run -e CONFIG.GIT_PROVIDER=bitbucket -e OPENAI.KEY=$OPENAI_API_KEY -e BITBUCKET.BEARER_TOKEN=$BITBUCKET_BEARER_TOKEN codiumai/pr-agent:latest --pr_url=https://bitbucket.org/$BITBUCKET_WORKSPACE/$BITBUCKET_REPO_SLUG/pull-requests/$BITBUCKET_PR_ID review
+```
+
+2. Add the following secure variables to your repository under Repository settings > Pipelines > Repository variables.
+OPENAI_API_KEY: `<your key>`
+BITBUCKET_BEARER_TOKEN: `<your token>`
+
+You can get a Bitbucket token for your repository by following Repository Settings -> Security -> Access Tokens.
+
+Note that comments on a PR are not supported in Bitbucket Pipeline.
+
+
+## Run using CodiumAI-hosted Bitbucket app
+
+Please contact [support@codium.ai](mailto:support@codium.ai) or visit [CodiumAI pricing page](https://www.codium.ai/pricing/) if you're interested in a hosted BitBucket app solution that provides full functionality including PR reviews and comment handling. It's based on the [bitbucket_app.py](https://github.com/Codium-ai/pr-agent/blob/main/pr_agent/git_providers/bitbucket_provider.py) implementation.
+
+
+## Bitbucket Server and Data Center
+
+Login into your on-prem instance of Bitbucket with your service account username and password.
+Navigate to `Manage account`, `HTTP Access tokens`, `Create Token`.
+Generate the token and add it to .secret.toml under `bitbucket_server` section
+
+```toml
+[bitbucket_server]
+bearer_token = "<your key>"
+```
+
+### Run it as CLI
+
+Modify `configuration.toml`:
+
+```toml
+git_provider="bitbucket_server"
+```
+
+and pass the Pull request URL:
+```shell
+python cli.py --pr_url https://git.onpreminstanceofbitbucket.com/projects/PROJECT/repos/REPO/pull-requests/1 review
+```
+
+### Run it as service
+
+To run pr-agent as webhook, build the docker image:
+```
+docker build . -t codiumai/pr-agent:bitbucket_server_webhook --target bitbucket_server_webhook -f docker/Dockerfile
+docker push codiumai/pr-agent:bitbucket_server_webhook  # Push to your Docker repository
+```
+
+Navigate to `Projects` or `Repositories`, `Settings`, `Webhooks`, `Create Webhook`.
+Fill the name and URL, Authentication None select the Pull Request Opened checkbox to receive that event as webhook.
+
+The URL should end with `/webhook`, for example: https://domain.com/webhook

docs/docs/installation/github.md

@@ -0,0 +1,249 @@
+## Run as a GitHub Action
+
+You can use our pre-built Github Action Docker image to run PR-Agent as a Github Action.
+
+1) Add the following file to your repository under `.github/workflows/pr_agent.yml`:
+
+```yaml
+on:
+  pull_request:
+  issue_comment:
+jobs:
+  pr_agent_job:
+    runs-on: ubuntu-latest
+    permissions:
+      issues: write
+      pull-requests: write
+      contents: write
+    name: Run pr agent on every pull request, respond to user comments
+    steps:
+      - name: PR Agent action step
+        id: pragent
+        uses: Codium-ai/pr-agent@main
+        env:
+          OPENAI_KEY: ${{ secrets.OPENAI_KEY }}
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+```
+** if you want to pin your action to a specific release (v0.7 for example) for stability reasons, use:
+```yaml
+on:
+  pull_request:
+  issue_comment:
+
+jobs:
+  pr_agent_job:
+    runs-on: ubuntu-latest
+    permissions:
+      issues: write
+      pull-requests: write
+      contents: write
+    name: Run pr agent on every pull request, respond to user comments
+    steps:
+      - name: PR Agent action step
+        id: pragent
+        uses: Codium-ai/pr-agent@v0.7
+        env:
+          OPENAI_KEY: ${{ secrets.OPENAI_KEY }}
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+```
+2) Add the following secret to your repository under `Settings > Secrets and variables > Actions > New repository secret > Add secret`:
+
+```
+Name = OPENAI_KEY
+Secret = <your key>
+```
+
+The GITHUB_TOKEN secret is automatically created by GitHub.
+
+3) Merge this change to your main branch.
+When you open your next PR, you should see a comment from `github-actions` bot with a review of your PR, and instructions on how to use the rest of the tools.
+
+4) You may configure PR-Agent by adding environment variables under the env section corresponding to any configurable property in the [configuration](https://github.com/Codium-ai/pr-agent/blob/main/pr_agent/settings/configuration.toml) file. Some examples:
+```yaml
+      env:
+        # ... previous environment values
+        OPENAI.ORG: "<Your organization name under your OpenAI account>"
+        PR_REVIEWER.REQUIRE_TESTS_REVIEW: "false" # Disable tests review
+        PR_CODE_SUGGESTIONS.NUM_CODE_SUGGESTIONS: 6 # Increase number of code suggestions
+```
+
+---
+
+## Run as a GitHub App
+Allowing you to automate the review process on your private or public repositories.
+
+1) Create a GitHub App from the [Github Developer Portal](https://docs.github.com/en/developers/apps/creating-a-github-app).
+
+   - Set the following permissions:
+     - Pull requests: Read & write
+     - Issue comment: Read & write
+     - Metadata: Read-only
+     - Contents: Read-only
+   - Set the following events:
+     - Issue comment
+     - Pull request
+     - Push (if you need to enable triggering on PR update)
+
+2) Generate a random secret for your app, and save it for later. For example, you can use:
+
+```
+WEBHOOK_SECRET=$(python -c "import secrets; print(secrets.token_hex(10))")
+```
+
+3) Acquire the following pieces of information from your app's settings page:
+
+   - App private key (click "Generate a private key" and save the file)
+   - App ID
+
+4) Clone this repository:
+
+```
+git clone https://github.com/Codium-ai/pr-agent.git
+```
+
+5) Copy the secrets template file and fill in the following:
+    
+```
+cp pr_agent/settings/.secrets_template.toml pr_agent/settings/.secrets.toml
+# Edit .secrets.toml file
+```
+
+   - Your OpenAI key.
+   - Copy your app's private key to the private_key field.
+   - Copy your app's ID to the app_id field.
+   - Copy your app's webhook secret to the webhook_secret field.
+   - Set deployment_type to 'app' in [configuration.toml](https://github.com/Codium-ai/pr-agent/blob/main/pr_agent/settings/configuration.toml)
+
+    > The .secrets.toml file is not copied to the Docker image by default, and is only used for local development.
+    > If you want to use the .secrets.toml file in your Docker image, you can add remove it from the .dockerignore file.
+    > In most production environments, you would inject the secrets file as environment variables or as mounted volumes.
+    > For example, in order to inject a secrets file as a volume in a Kubernetes environment you can update your pod spec to include the following,
+    > assuming you have a secret named `pr-agent-settings` with a key named `.secrets.toml`:
+    ```
+           volumes:
+            - name: settings-volume
+              secret:
+                secretName: pr-agent-settings
+    // ...
+           containers:
+    // ...
+              volumeMounts:
+                - mountPath: /app/pr_agent/settings_prod
+                  name: settings-volume
+    ```
+    
+    > Another option is to set the secrets as environment variables in your deployment environment, for example `OPENAI.KEY` and `GITHUB.USER_TOKEN`.
+
+6) Build a Docker image for the app and optionally push it to a Docker repository. We'll use Dockerhub as an example:
+
+    ```
+    docker build . -t codiumai/pr-agent:github_app --target github_app -f docker/Dockerfile
+    docker push codiumai/pr-agent:github_app  # Push to your Docker repository
+    ```
+
+7. Host the app using a server, serverless function, or container environment. Alternatively, for development and
+   debugging, you may use tools like smee.io to forward webhooks to your local machine.
+    You can check [Deploy as a Lambda Function](#deploy-as-a-lambda-function)
+
+8. Go back to your app's settings, and set the following:
+
+   - Webhook URL: The URL of your app's server or the URL of the smee.io channel.
+   - Webhook secret: The secret you generated earlier.
+
+9. Install the app by navigating to the "Install App" tab and selecting your desired repositories.
+
+> **Note:** When running PR-Agent from GitHub App, the default configuration file (configuration.toml) will be loaded.
+> However, you can override the default tool parameters by uploading a local configuration file `.pr_agent.toml`
+> For more information please check out the [USAGE GUIDE](../usage-guide/automations_and_usage.md#github-app)
+---
+
+## Deploy as a Lambda Function
+
+1. Follow steps 1-5 from [here](#run-as-a-github-app).
+2. Build a docker image that can be used as a lambda function
+    ```shell
+    docker buildx build --platform=linux/amd64 . -t codiumai/pr-agent:serverless -f docker/Dockerfile.lambda
+   ```
+3. Push image to ECR
+    ```shell
+	docker tag codiumai/pr-agent:serverless <AWS_ACCOUNT>.dkr.ecr.<AWS_REGION>.amazonaws.com/codiumai/pr-agent:serverless
+	docker push <AWS_ACCOUNT>.dkr.ecr.<AWS_REGION>.amazonaws.com/codiumai/pr-agent:serverless
+    ```
+4. Create a lambda function that uses the uploaded image. Set the lambda timeout to be at least 3m.
+5. Configure the lambda function to have a Function URL.
+6. In the environment variables of the Lambda function, specify `AZURE_DEVOPS_CACHE_DIR` to a writable location such as /tmp. (see [link](https://github.com/Codium-ai/pr-agent/pull/450#issuecomment-1840242269))
+7. Go back to steps 8-9 of [Method 5](#run-as-a-github-app) with the function url as your Webhook URL.
+    The Webhook URL would look like `https://<LAMBDA_FUNCTION_URL>/api/v1/github_webhooks`
+
+---
+
+## AWS CodeCommit Setup
+
+Not all features have been added to CodeCommit yet.  As of right now, CodeCommit has been implemented to run the pr-agent CLI on the command line, using AWS credentials stored in environment variables.  (More features will be added in the future.)  The following is a set of instructions to have pr-agent do a review of your CodeCommit pull request from the command line:
+
+1. Create an IAM user that you will use to read CodeCommit pull requests and post comments
+    * Note: That user should have CLI access only, not Console access
+2. Add IAM permissions to that user, to allow access to CodeCommit (see IAM Role example below)
+3. Generate an Access Key for your IAM user
+4. Set the Access Key and Secret using environment variables (see Access Key example below)
+5. Set the `git_provider` value to `codecommit` in the `pr_agent/settings/configuration.toml` settings file
+6. Set the `PYTHONPATH` to include your `pr-agent` project directory
+    * Option A: Add `PYTHONPATH="/PATH/TO/PROJECTS/pr-agent` to your `.env` file
+    * Option B: Set `PYTHONPATH` and run the CLI in one command, for example:
+        * `PYTHONPATH="/PATH/TO/PROJECTS/pr-agent python pr_agent/cli.py [--ARGS]`
+
+---
+
+
+#### AWS CodeCommit IAM Role Example
+
+Example IAM permissions to that user to allow access to CodeCommit:
+
+* Note: The following is a working example of IAM permissions that has read access to the repositories and write access to allow posting comments
+* Note: If you only want pr-agent to review your pull requests, you can tighten the IAM permissions further, however this IAM example will work, and allow the pr-agent to post comments to the PR
+* Note: You may want to replace the `"Resource": "*"` with your list of repos, to limit access to only those repos
+
+```
+{
+    "Version": "2012-10-17",
+    "Statement": [
+        {
+            "Effect": "Allow",
+            "Action": [
+                "codecommit:BatchDescribe*",
+                "codecommit:BatchGet*",
+                "codecommit:Describe*",
+                "codecommit:EvaluatePullRequestApprovalRules",
+                "codecommit:Get*",
+                "codecommit:List*",
+                "codecommit:PostComment*",
+                "codecommit:PutCommentReaction",
+                "codecommit:UpdatePullRequestDescription",
+                "codecommit:UpdatePullRequestTitle"
+            ],
+            "Resource": "*"
+        }
+    ]
+}
+```
+
+#### AWS CodeCommit Access Key and Secret
+
+Example setting the Access Key and Secret using environment variables
+
+```sh
+export AWS_ACCESS_KEY_ID="XXXXXXXXXXXXXXXX"
+export AWS_SECRET_ACCESS_KEY="XXXXXXXXXXXXXXXX"
+export AWS_DEFAULT_REGION="us-east-1"
+```
+
+#### AWS CodeCommit CLI Example
+
+After you set up AWS CodeCommit using the instructions above, here is an example CLI run that tells pr-agent to **review** a given pull request.
+(Replace your specific PYTHONPATH and PR URL in the example)
+
+```sh
+PYTHONPATH="/PATH/TO/PROJECTS/pr-agent" python pr_agent/cli.py \
+  --pr_url https://us-east-1.console.aws.amazon.com/codesuite/codecommit/repositories/MY_REPO_NAME/pull-requests/321 \
+  review
+```

docs/docs/installation/gitlab.md

@@ -0,0 +1,20 @@
+## Run a GitLab webhook server
+
+1. From the GitLab workspace or group, create an access token. Enable the "api" scope only.
+
+2. Generate a random secret for your app, and save it for later. For example, you can use:
+
+```
+WEBHOOK_SECRET=$(python -c "import secrets; print(secrets.token_hex(10))")
+```
+3. Follow the instructions to build the Docker image, setup a secrets file and deploy on your own server from [here](https://pr-agent-docs.codium.ai/installation/github/#run-as-a-github-app) steps 4-7.
+
+4. In the secrets file, fill in the following:
+    - Your OpenAI key.
+    - In the [gitlab] section, fill in personal_access_token and shared_secret. The access token can be a personal access token, or a group or project access token.
+    - Set deployment_type to 'gitlab' in [configuration.toml](https://github.com/Codium-ai/pr-agent/blob/main/pr_agent/settings/configuration.toml)
+   
+5. Create a webhook in GitLab. Set the URL to the URL of your app's server. Set the secret token to the generated secret from step 2.
+In the "Trigger" section, check the ‘comments’ and ‘merge request events’ boxes.
+
+6. Test your installation by opening a merge request or commenting or a merge request using one of CodiumAI's commands.

docs/docs/installation/index.md

@@ -0,0 +1,19 @@
+# Installation
+
+If you choose to host you own PR-Agent, you first need to acquire two tokens:
+
+1. An OpenAI key from [here](https://platform.openai.com/api-keys), with access to GPT-4 (or a key for [other models](../usage-guide/additional_configurations.md/#changing-a-model), if you prefer).
+2. A GitHub\GitLab\BitBucket personal access token (classic), with the repo scope. [GitHub from [here](https://github.com/settings/tokens)]
+
+There are several ways to use self-hosted PR-Agent:
+
+- [Locally](./locally.md)
+- [GitHub](./github.md)
+- [GitLab](./gitlab.md)
+- [BitBucket](./bitbucket.md)
+- [Azure DevOps](./azure.md)
+
+___
+Note that [PR-Agent Pro 💎](https://app.codium.ai/), an app for GitHub\GitLab\BitBucket hosted by CodiumAI, is also available. 
+<br>
+With PR-Agent Pro Installation is as simple as signing up and adding the PR-Agent app to your relevant repo.

docs/docs/installation/locally.md

@@ -0,0 +1,84 @@
+## Use Docker image (no installation required)
+
+A list of the relevant tools can be found in the [tools guide](../tools/ask.md).
+
+To invoke a tool (for example `review`), you can run directly from the Docker image. Here's how:
+
+- For GitHub:
+```
+docker run --rm -it -e OPENAI.KEY=<your key> -e GITHUB.USER_TOKEN=<your token> codiumai/pr-agent:latest --pr_url <pr_url> review
+```
+
+- For GitLab:
+```
+docker run --rm -it -e OPENAI.KEY=<your key> -e CONFIG.GIT_PROVIDER=gitlab -e GITLAB.PERSONAL_ACCESS_TOKEN=<your token> codiumai/pr-agent:latest --pr_url <pr_url> review
+```
+
+Note: If you have a dedicated GitLab instance, you need to specify the custom url as variable:
+```
+docker run --rm -it -e OPENAI.KEY=<your key> -e CONFIG.GIT_PROVIDER=gitlab -e GITLAB.PERSONAL_ACCESS_TOKEN=<your token> -e GITLAB.URL=<your gitlab instance url> codiumai/pr-agent:latest --pr_url <pr_url> review
+```
+
+- For BitBucket:
+```
+docker run --rm -it -e CONFIG.GIT_PROVIDER=bitbucket -e OPENAI.KEY=$OPENAI_API_KEY -e BITBUCKET.BEARER_TOKEN=$BITBUCKET_BEARER_TOKEN codiumai/pr-agent:latest --pr_url=<pr_url> review
+```
+
+For other git providers, update CONFIG.GIT_PROVIDER accordingly, and check the `pr_agent/settings/.secrets_template.toml` file for the environment variables expected names and values.
+
+---
+
+
+If you want to ensure you're running a specific version of the Docker image, consider using the image's digest:
+```bash
+docker run --rm -it -e OPENAI.KEY=<your key> -e GITHUB.USER_TOKEN=<your token> codiumai/pr-agent@sha256:71b5ee15df59c745d352d84752d01561ba64b6d51327f97d46152f0c58a5f678 --pr_url <pr_url> review
+```
+
+Or you can run a [specific released versions](https://github.com/Codium-ai/pr-agent/blob/main/RELEASE_NOTES.md) of pr-agent, for example:
+```
+codiumai/pr-agent@v0.9
+```
+
+---
+
+## Run from source
+
+1. Clone this repository:
+
+```
+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:
+
+```
+pip install -e .
+```
+
+*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:
+
+```
+cp pr_agent/settings/.secrets_template.toml pr_agent/settings/.secrets.toml
+chmod 600 pr_agent/settings/.secrets.toml
+# Edit .secrets.toml file
+```
+
+4. Run the cli.py script:
+
+```
+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> describe
+python3 -m pr_agent.cli --pr_url <pr_url> improve
+python3 -m pr_agent.cli --pr_url <pr_url> add_docs
+python3 -m pr_agent.cli --pr_url <pr_url> generate_labels
+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>
+```

docs/docs/tools/analyze.md

@@ -0,0 +1,24 @@
+## Overview
+The `analyze` tool combines static code analysis with LLM capabilities to provide a comprehensive analysis of the PR code changes.
+
+The tool scans the PR code changes, find the code components (methods, functions, classes) that changed, and summarizes the changes in each component.
+
+It can be invoked manually by commenting on any PR:
+```
+/analyze
+```
+
+## Example usage
+An example [result](https://github.com/Codium-ai/pr-agent/pull/546#issuecomment-1868524805):
+
+<kbd><img src=https://codium.ai/images/pr_agent/analyze_1.png width="768"></kbd>
+
+<kbd><img src=https://codium.ai/images/pr_agent/analyze_2.png width="768"></kbd>
+
+<kbd><img src=https://codium.ai/images/pr_agent/analyze_3.png width="768"></kbd>
+
+
+
+**Notes**
+
+- Language that are currently supported: Python, Java, C++, JavaScript, TypeScript.

docs/docs/tools/ask.md

@@ -0,0 +1,23 @@
+## Overview
+
+The `ask` tool answers questions about the PR, based on the PR code changes. Make sure to be specific and clear in your questions.
+It can be invoked manually by commenting on any PR:
+```
+/ask "..."
+```
+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>
+
+## Ask lines
+
+You can run `/ask` on specific lines of code in the PR from the PR's diff view. The tool will answer questions based on the code changes in the selected lines.
+- Click on the '+' sign next to the line number to select the line.
+- To select multiple lines, click on the '+' sign of the first line and then hold and drag to select the rest of the lines. 
+- write `/ask "..."` in the comment box and press `Add single comment` button.
+
+<kbd><img src="https://codium.ai/images/pr_agent/Ask_line.png" width="768"></kbd>
+
+Note that the tool does not have "memory" of previous questions, and answers each question independently.

docs/docs/tools/ci_feedback.md

@@ -0,0 +1,32 @@
+## Overview
+
+The CI feedback tool (`/checks)` automatically triggers when a PR has a failed check.
+The tool analyzes the failed checks and provides several feedbacks:
+
+- Failed stage
+- Failed test name
+- Failure summary
+- Relevant error logs
+
+<kbd>
+<img src="https://www.codium.ai/images/pr_agent/failed_check1.png" width="768">
+</kbd>
+&rarr;
+<kbd>
+<img src="https://www.codium.ai/images/pr_agent/failed_check2.png" width="768">
+</kbd>
+
+___
+
+In addition to being automatically triggered, the tool can also be invoked manually by commenting on a PR:
+```
+/checks "https://github.com/{repo_name}/actions/runs/{run_number}/job/{job_number}"
+```
+where `{repo_name}` is the name of the repository, `{run_number}` is the run number of the failed check, and `{job_number}` is the job number of the failed check.
+
+## Configuration options
+- `enable_auto_checks_feedback` - if set to true, the tool will automatically provide feedback when a check is failed. Default is true.
+- `excluded_checks_list` - a list of checks to exclude from the feedback, for example: ["check1", "check2"]. Default is an empty list.
+- `persistent_comment` - if set to true, the tool will overwrite a previous checks comment with the new feedback. Default is true.
+- `enable_help_text=true` - if set to true, the tool will provide a help message when a user comments "/checks" on a PR. Default is true.
+- `final_update_message` - if `persistent_comment` is true and updating a previous checks message, the tool will also create a new message: "Persistent checks updated to latest commit". Default is true.

docs/docs/tools/custom_labels.md

@@ -0,0 +1,58 @@
+## Overview
+The `generate_labels` tool scans the PR code changes, and given a list of labels and their descriptions, it automatically suggests labels that match the PR code changes.
+
+It can be invoked manually by commenting on any PR:
+```
+/generate_labels
+```
+For example:
+
+If we wish to add detect changes to SQL queries in a given PR, we can add the following custom label along with its description:
+
+<kbd><img src=https://codium.ai/images/pr_agent/custom_labels_list.png width="768"></kbd>
+
+When running the `generate_labels` tool on a PR that includes changes in SQL queries, it will automatically suggest the custom label:
+
+<kbd><img src=https://codium.ai/images/pr_agent/custom_label_published.png width="768"></kbd>
+
+Note that in addition to the dedicated tool `generate_labels`, the custom labels will also be used by the `describe` tool.
+
+### How to enable custom labels
+There are 3 ways to enable custom labels:
+
+#### 1. CLI (local configuration file)
+When working from CLI, you need to apply the [configuration changes](#configuration-options) to the [custom_labels file](https://github.com/Codium-ai/pr-agent/blob/main/pr_agent/settings/custom_labels.toml):
+
+#### 2. Repo configuration file
+To enable custom labels, you need to apply the [configuration changes](#configuration-options) to the local `.pr_agent.toml` file in you repository.
+
+#### 3. Handle custom labels from the Repo's labels page 💎
+> This feature is available only in PR-Agent Pro 
+
+* GitHub : `https://github.com/{owner}/{repo}/labels`, or click on the "Labels" tab in the issues or PRs page.
+* GitLab : `https://gitlab.com/{owner}/{repo}/-/labels`, or click on "Manage" -> "Labels" on the left menu.
+
+b. Add/edit the custom labels. It should be formatted as follows:
+* Label name: The name of the custom label.
+* Description: Start the description of with prefix `pr_agent:`, for example: `pr_agent: Description of when AI should suggest this label`.<br>
+The description should be comprehensive and detailed, indicating when to add the desired label.
+<kbd><img src=https://codium.ai/images/pr_agent/add_native_custom_labels.png width="880"></kbd>
+
+c. Now the custom labels will be included in the `generate_labels` tool.
+
+> This feature is supported in GitHub and GitLab.
+
+## Configuration options
+ - Change `enable_custom_labels` to True: This will turn off the default labels and enable the custom labels provided in the custom_labels.toml file.
+ - Add the custom labels. It should be formatted as follows:
+
+```
+[config]
+enable_custom_labels=true
+
+[custom_labels."Custom Label Name"]
+description = "Description of when AI should suggest this label"
+
+[custom_labels."Custom Label 2"]
+description = "Description of when AI should suggest this label 2"
+```

docs/docs/tools/custom_suggestions.md

@@ -0,0 +1,57 @@
+## 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](../usage-guide/automations_and_usage.md#github-app-automatic-tools-when-a-new-pr-is-opened) 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](../usage-guide/automations_and_usage.md#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.

docs/docs/tools/describe.md

@@ -0,0 +1,153 @@
+## Overview
+The `describe` tool scans the PR code changes, and generates a description for the PR - title, type, summary, walkthrough and labels.
+
+The tool can be triggered automatically every time a new PR is [opened](../usage-guide/automations_and_usage.md#github-app-automatic-tools-when-a-new-pr-is-opened), or it can be invoked manually by commenting on any PR:
+```
+/describe
+```
+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_new.png width="768"></kbd>
+
+
+  
+## Configuration options
+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=...
+```
+
+### Possible configurations:
+
+- `publish_labels`: if set to true, the tool will publish the labels to the PR. Default is true.
+
+- `publish_description_as_comment`: if set to true, the tool will publish the description as a comment to the PR. If false, it will overwrite the origianl description. Default is false.
+
+- `add_original_user_description`: if set to true, the tool will add the original user description to the generated description. Default is true.
+
+- `keep_original_user_title`: if set to true, the tool will keep the original PR title, and won't change it. Default is true.
+
+- `extra_instructions`: Optional extra instructions to the tool. For example: "focus on the changes in the file X. Ignore change in ...".
+
+- To enable `custom labels`, apply the configuration changes described [here](./custom_labels.md#configuration-options)
+
+- `enable_pr_type`: if set to false, it will not show the `PR type` as a text value in the description content. Default is true.
+
+- `final_update_message`: if set to true, it will add a comment message [`PR Description updated to latest commit...`](https://github.com/Codium-ai/pr-agent/pull/499#issuecomment-1837412176) after finishing calling `/describe`. 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".
+  
+### Inline file summary 💎
+> This feature is available only in PR-Agent Pro
+
+This feature will enable you to quickly understand the changes in each file while reviewing the code changes (diff view).
+
+To add the walkthrough table to the "Files changed" tab, you can click on the checkbox that appears PR Description status message below the main PR Description:
+
+<kbd><img src=https://codium.ai/images/pr_agent/add_table_checkbox.png width="512"></kbd>
+
+If you prefer to have the file summaries appear in the "Files changed" tab on every PR, change the `pr_description.inline_file_summary` parameter 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="768"></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="768"></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 💎
+> This feature is available only in PR-Agent Pro 
+
+You can control  the custom labels that will be suggested by the `describe` tool, from the repo's labels page:
+
+* GitHub : go to `https://github.com/{owner}/{repo}/labels` (or click on the "Labels" tab in the issues or PRs page)
+* GitLab : go to `https://gitlab.com/{owner}/{repo}/-/labels` (or click on "Manage" -> "Labels" on the left menu)
+
+Now add/edit the custom labels. they should be formatted as follows:
+* Label name: The name of the custom label.
+* Description: Start the description of with prefix `pr_agent:`, for example: `pr_agent: Description of when AI should suggest this label`.<br>
+
+The description should be comprehensive and detailed, indicating when to add the desired label. For example:
+<kbd><img src=https://codium.ai/images/pr_agent/add_native_custom_labels.png width="880"></kbd>
+
+
+### Markers template
+
+To enable markers, set `pr_description.use_description_markers=true`.
+Markers enable to easily integrate user's content and auto-generated content, with a template-like mechanism.
+
+For example, if the PR original description was:
+```
+User content...
+
+## PR Type:
+pr_agent:type
+
+## PR Description:
+pr_agent:summary
+
+## PR Walkthrough:
+pr_agent:walkthrough
+```
+The marker `pr_agent:type` will be replaced with the PR type, `pr_agent:summary` will be replaced with the PR summary, and `pr_agent:walkthrough` will be replaced with the PR walkthrough.
+
+<kbd><img src=https://codium.ai/images/pr_agent/describe_markers_before.png width="768"></kbd>
+&rarr;
+<kbd><img src=https://codium.ai/images/pr_agent/describe_markers_after.png width="768"></kbd>
+
+### Configuration params:
+
+- `use_description_markers`: if set to true, the tool will use markers template. It replaces every marker of the form `pr_agent:marker_name` with the relevant content. Default is false.
+- `include_generated_by_header`: if set to true, the tool will add a dedicated header: 'Generated by PR Agent at ...' to any automatic content. Default is true.
+
+
+## Usage Tips
+
+### Automation
+- When you first install the app, the [default mode](../usage-guide/automations_and_usage.md#github-app) 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. 
+<br> This default settings aim to strike a good balance between automation and control:
+If you want more automation, just give the PR a title, and the tool will auto-write a full description; If you want more control, you can add a detailed description, and the tool will add the complementary description below it.
+- For maximal automation, you can change the default mode to:
+```
+pr_commands = ["/describe --pr_description.add_original_user_description=false" 
+                         "--pr_description.keep_original_user_title=true", ...]
+```
+so the title will be auto-generated as well.
+- 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.
+
+### Custom labels
+
+The default labels of the describe tool are quite generic, since they are meant to be used in any repo: [`Bug fix`, `Tests`, `Enhancement`, `Documentation`, `Other`].
+
+If you specify [custom labels](#handle-custom-labels-from-the-repos-labels-page) in the repo's labels page, 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.
+<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.

docs/docs/tools/documentation.md

@@ -0,0 +1,24 @@
+## Overview
+The `add_docs` tool scans the PR code changes, and automatically suggests documentation for any code components that changed in the PR (functions, classes, etc.).
+
+It can be invoked manually by commenting on any PR:
+```
+/add_docs
+```
+For example:
+
+<kbd><img src=https://codium.ai/images/pr_agent/docs_command.png width="768"></kbd>
+
+<kbd><img src=https://codium.ai/images/pr_agent/docs_components.png width="768"></kbd>
+
+<kbd><img src=https://codium.ai/images/pr_agent/docs_single_component.png width="768"></kbd>
+
+## Configuration options
+ - `docs_style`: The exact style of the documentation (for python docstring). you can choose between: `google`, `numpy`, `sphinx`, `restructuredtext`, `plain`. Default is `sphinx`.
+ - `extra_instructions`: Optional extra instructions to the tool. For example: "focus on the changes in the file X. Ignore change in ...".
+
+**Notes**
+
+- Language that are currently fully supported: Python, Java, C++, JavaScript, TypeScript.
+- For languages that are not fully supported, the tool will suggest documentation only for new components in the PR.
+- A previous version of the tool, that offered support only for new components, was deprecated.

docs/docs/tools/improve.md

@@ -0,0 +1,89 @@
+## Overview
+The `improve` tool scans the PR code changes, and automatically generates suggestions for improving the PR code.
+The tool can be triggered automatically every time a new PR is [opened](../usage-guide/automations_and_usage.md#github-app-automatic-tools-when-a-new-pr-is-opened), or it can be invoked manually by commenting on any PR:
+```
+/improve
+```
+
+### Summarized vs committable code suggestions
+
+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/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>
+
+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:
+```
+/improve --extended
+```
+
+or by setting:
+```
+[pr_code_suggestions]
+auto_extended_mode=true
+```
+(True by default).
+
+Note that the extended mode divides the PR code changes into chunks, up to the token limits, where each chunk is handled separately (might use multiple calls to GPT-4 for large PRs).
+Hence, the total number of suggestions is proportional to the number of chunks, i.e., the size of the PR.
+
+### Configuration options
+
+To edit [configurations](https://github.com/Codium-ai/pr-agent/blob/main/pr_agent/settings/configuration.toml#L66) related to the improve tool (`pr_code_suggestions` section), use the following template:
+```
+/improve --pr_code_suggestions.some_config1=... --pr_code_suggestions.some_config2=...
+```
+
+### General options
+
+- `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 ...".
+- `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.
+- `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
+
+- `auto_extended_mode`: enable extended mode automatically (no need for the `--extended` option). Default is true.
+- `num_code_suggestions_per_chunk`: number of code suggestions provided by the 'improve' tool, per chunk. Default is 8.
+- `rank_extended_suggestions`: if set to true, the tool will rank the suggestions, based on importance. Default is true.
+- `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.
+
+
+## Usage Tips
+
+### Extra instructions
+
+Extra instructions are very important for the `imrpove` tool, since they enable you 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.
+
+### 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.
+- Suggestions are not meant to be [simplistic](https://github.com/Codium-ai/pr-agent/blob/main/pr_agent/settings/pr_code_suggestions_prompts.toml#L34). 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 `exra_instructions` field to guide the model to suggestions that are more relevant to the specific needs of the project.
+- Consider also trying the [Custom Suggestions Tool](./custom_suggestions.md) 💎, that will **only** propose suggestions that follow specific guidelines defined by user.

docs/docs/tools/index.md

@@ -0,0 +1,20 @@
+# Tools
+
+Here is a list of PR-Agent tools, each with a dedicated page that explains how to use it:
+
+| Tool                                                                          | Description                                                                                                                                 |
+|-------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------|
+| **[PR Description (`/describe`](./describe.md))**                             | Automatically generating PR description - title, type, summary, code walkthrough and labels                                                 |
+| **[PR Review (`/review`](./review.md))**                                      | Adjustable feedback about the PR, possible issues, security concerns, review effort and more                                                |
+| **[Code Suggestions (`/improve`](./improve.md))**                             | Code suggestions for improving the PR                                                                                                       |
+| **[Question Answering (`/ask ...`](./ask.md))**                               | Answering free-text questions about the PR, or on specific code lines                                                                       |
+| **[Update Changelog (`/update_changelog`](./update_changelog.md))**           | Automatically updating the CHANGELOG.md file with the PR changes                                                                            |
+| **[Find Similar Issue (`/similar_issue`](./similar_issues.md))**              | Automatically retrieves and presents similar issues                                                                                         |
+| **💎 [Add Documentation (`/add_docs`](./documentation.md))**                  | Generates documentation to methods/functions/classes that changed in the PR                                                                 |
+| **💎 [Generate Custom Labels (`/generate_labels`](./custom_labels.md))** | Generates custom labels for the PR, based on specific guidelines defined by the user                                                        |
+| **💎 [Analyze (`/analyze`](./analyze.md))**                                   | Identify code components that changed in the PR, and enables to interactively generate tests, docs, and code suggestions for each component |
+| **💎 [Custom Suggestions (`/custom_suggestions`](./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`](./test.md))**                   | Automatically generates unit tests for a selected component, based on the PR code changes                                                   |
+| **💎 [CI Feedback (`/checks ci_job`](./ci_feedback.md))**                     | Automatically generates feedback and analysis for a failed CI job                                                                           |
+
+Note that the tools marked with 💎 are available only for PR-Agent Pro users.

docs/docs/tools/review.md

@@ -0,0 +1,168 @@
+## Overview
+The `review` tool scans the PR code changes, and automatically generates a PR review.
+The tool can be triggered automatically every time a new PR is [opened](../usage-guide/automations_and_usage.md#github-app-automatic-tools-when-a-new-pr-is-opened), or can be invoked manually by commenting on any PR:
+```
+/review
+```
+For example:
+
+<kbd><img src=https://codium.ai/images/pr_agent/review_comment.png width="768"></kbd>
+
+<kbd><img src=https://codium.ai/images/pr_agent/review.png width="768"></kbd>
+
+
+## Configuration options
+
+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=...
+```
+
+#### General options
+- `num_code_suggestions`: number of code suggestions provided by the 'review' tool. For manual comments, default is 4. For [PR-Agent app](https://github.com/Codium-ai/pr-agent/blob/main/pr_agent/settings/configuration.toml#L142) auto tools, default is 0, meaning no code suggestions will be provided by the review tool, unless you manually edit `pr_commands`.
+- `inline_code_comments`: if set to true, the tool will publish the code suggestions as comments on the code diff. Default is false.
+- `persistent_comment`: if set to true, the review comment will be persistent, meaning that every new review request will edit the previous one. Default is true.
+- `extra_instructions`: Optional extra instructions to the tool. For example: "focus on the changes in the file X. Ignore change in ...".
+
+#### Enable\\disable features
+- `require_focused_review`: if set to true, the tool will add a section - 'is the PR a focused one'. 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_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.
+
+#### SOC2 ticket compliance 💎
+> This feature is available only in PR-Agent Pro 
+
+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.
+- `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
+- `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.
+
+#### Auto-approval
+- `enable_auto_approval`: if set to true, the tool will approve the PR when invoked with the 'auto_approve' command. Default is false. This flag can be changed only from configuration file.
+- `maximal_review_effort`: maximal effort level for auto-approval. If the PR's estimated review effort is above this threshold, the auto-approval will not run. Default is 5.
+
+#### 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.
+For invoking the incremental mode, the following command can be used:
+```
+/review -i
+```
+Note that the incremental mode is only available for GitHub.
+
+<kbd><img src=https://codium.ai/images/pr_agent/incremental_review.png width="768"></kbd>
+
+Under the section 'pr_reviewer', the [configuration file](https://github.com/Codium-ai/pr-agent/blob/main/pr_agent/settings/configuration.toml#L19) contains options to customize the 'review -i' tool.  
+These configurations can be used to control the rate at which the incremental review tool will create new review comments when invoked automatically, to prevent making too much noise in the PR.
+- `minimal_commits_for_incremental_review`: Minimal number of commits since the last review that are required to create incremental review.
+If there are less than the specified number of commits since the last review, the tool will not perform any action.
+Default is 0 - the tool will always run, no matter how many commits since the last review.
+- `minimal_minutes_for_incremental_review`: Minimal number of minutes that need to pass since the last reviewed commit to create incremental review.
+If less than the specified number of minutes have passed between the last reviewed commit and running this command, the tool will not perform any action. 
+Default is 0 - the tool will always run, no matter how much time have passed since the last reviewed commit.
+- `require_all_thresholds_for_incremental_review`: If set to true, all the previous thresholds must be met for incremental review to run. If false, only one is enough to run the tool.
+For example, if `minimal_commits_for_incremental_review=2` and `minimal_minutes_for_incremental_review=2`, and we have 3 commits since the last review, but the last reviewed commit is from 1 minute ago:
+When `require_all_thresholds_for_incremental_review=true` the incremental review __will not__ run, because only 1 out of 2 conditions were met (we have enough commits but the last review is too recent),
+but when `require_all_thresholds_for_incremental_review=false` the incremental review __will__ run, because one condition is enough (we have 3 commits which is more than the configured 2).
+Default is false - the tool will run as long as at least once conditions is met.
+
+#### PR Reflection
+
+By invoking:
+```
+/reflect_and_review
+```
+The tool will first ask the author questions about the PR, and will guide the review based on their answers.
+
+<kbd><img src=https://codium.ai/images/pr_agent/reflection_questions.png width="768"></kbd>
+
+<kbd><img src=https://codium.ai/images/pr_agent/reflection_answers.png width="768"></kbd>
+
+<kbd><img src=https://codium.ai/images/pr_agent/reflection_insights.png width="768"></kbd>
+
+
+
+## Usage Tips
+
+### General guidelines
+
+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.
+
+Some of the features that are disabled by default are quite useful, and should be considered for enabling. For example: 
+`require_score_review`, `require_soc2_ticket`, 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.
+
+### Code suggestions
+
+If you set `num_code_suggestions`>0 , the `review` tool will also provide code suggestions.
+
+Notice If you are interested **only** in the code suggestions, it is recommended to use the [`improve`](./improve.md) feature instead, since it is a dedicated only to code suggestions, and usually gives better results.
+Use the `review` tool if you want to get more comprehensive feedback, which includes code suggestions as well.
+
+### Automation
+- When you first install the app, the [default mode](../usage-guide/automations_and_usage.md#github-app-automatic-tools-when-a-new-pr-is-opened) 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.
+
+### Auto-labels
+
+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 `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.
+
+### Extra instructions
+
+Extra instructions 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.
+
+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 code feedback 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.
+
+
+### Auto-approval
+
+PR-Agent can approve a PR when a specific comment is invoked.
+
+To ensure safety, the auto-approval feature is disabled by default. To enable auto-approval, you need to actively set in a pre-defined configuration file the following:
+```
+[pr_reviewer]
+enable_auto_approval = true
+```
+(this specific flag cannot be set with a command line argument, only in the configuration file, committed to the repository)
+
+
+After enabling, by commenting on a PR:
+```
+/review auto_approve
+```
+PR-Agent will automatically approve the PR, and add a comment with the approval.
+
+
+You can also enable auto-approval only if the PR meets certain requirements, such as that the `estimated_review_effort` label is equal or below a certain threshold, by adjusting the flag:
+```
+[pr_reviewer]
+maximal_review_effort = 5
+```

docs/docs/tools/similar_code.md

@@ -0,0 +1,61 @@
+## Overview
+The similar code tool retrieves the most similar code components from inside the organization's codebase, or from open-source code.
+
+For example:
+
+`Global Search` for a method called `chat_completion`:
+
+<kbd><img src=https://codium.ai/images/pr_agent/similar_code_global2.png width="768"></kbd>
+
+PR-Agent will examine the code component and will extract the most relevant keywords to search for similar code:
+
+- `extracted keywords`: the keywords that were extracted from the code by PR-Agent. the link will open a search page with the extracted keywords, to allow the user to modify the search if needed.
+- `search context`: the context in which the search will be performed, organization's codebase or open-source code (Global).
+- `similar code`: the most similar code components found. the link will open the code component in the relevant file.
+- `relevant repositories`: the open-source repositories in which that are relevant to the searched code component and it's keywords.
+
+Search result link example:
+
+<kbd><img src=https://codium.ai/images/pr_agent/code_search_result_single.png width="768"></kbd>
+
+`Organization Search`:
+
+<kbd><img src=https://codium.ai/images/pr_agent/similar_code_org.png width="768"></kbd>
+
+
+## How to use
+### Manually
+To invoke the `similar code` tool manually, comment on the PR:
+```
+/find_similar_component COMPONENT_NAME
+```
+Where `COMPONENT_NAME` should be the name of a code component in the PR (class, method, function).
+
+If there is a name ambiguity, there are two configurations that will help the tool to find the correct component:
+
+- `--pr_find_similar_component.file`: in case there are several components with the same name, you can specify the relevant file.
+- `--pr_find_similar_component.class_name`: in case there are several methods with the same name in the same file, you can specify the relevant class name.
+
+example:
+```
+/find_similar_component COMPONENT_NAME --pr_find_similar_component.file=FILE_NAME
+```
+
+### Automatically (via Analyze table)
+It can be invoked automatically from the analyze table, can be accessed by:
+```
+/analyze
+```
+Choose the components you want to find similar code for, and click on the `similar` checkbox.
+<kbd><img src=https://codium.ai/images/pr_agent/analyze_similar.png width="768"></kbd>
+
+If you are looking to search for similar code in the organization's codebase, you can click on the `Organization` checkbox, and it will invoke a new search command just for the organization's codebase. 
+
+<kbd><img src=https://codium.ai/images/pr_agent/similar_code_global.png width="768"></kbd>
+
+
+## Configuration options
+
+- `search_from_org`: if set to true, the tool will search for similar code in the organization's codebase. Default is false.
+- `number_of_keywords`: number of keywords to use for the search. Default is 5.
+- `number_of_results`: the maximum number of results to present. Default is 5.

docs/docs/tools/similar_issues.md

@@ -1,4 +1,4 @@
-# Similar Issue Tool
+## Overview
 The similar issue tool retrieves the most similar issues to the current issue.
 It can be invoked manually by commenting on any PR:
 ```
@@ -7,12 +7,22 @@ It can be invoked manually by commenting on any PR:
 For example:
 
 <kbd><img src=https://codium.ai/images/pr_agent/similar_issue_original_issue.png width="768"></kbd>
+
 <kbd><img src=https://codium.ai/images/pr_agent/similar_issue_comment.png width="768"></kbd>
+
 <kbd><img src=https://codium.ai/images/pr_agent/similar_issue.png width="768"></kbd>
 
 Note that to perform retrieval, the `similar_issue` tool indexes all the repo previous issues (once).
 
-To enable usage of the '**similar issue**' tool, you need to set the following keys in `.secrets.toml` (or in the relevant environment variables):
+
+**Select VectorDBs** by changing `pr_similar_issue` parameter in `configuration.toml` file 
+
+2 VectorDBs are available to switch in
+1. LanceDB
+2. Pinecone
+
+To enable usage of the '**similar issue**' tool for Pinecone, you need to set the following keys in `.secrets.toml` (or in the relevant environment variables):
+
 ```
 [pinecone]
 api_key = "..."
@@ -21,11 +31,11 @@ environment = "..."
 These parameters can be obtained by registering to [Pinecone](https://app.pinecone.io/?sessionType=signup/).
 
 
-### How to use:
+## How to use:
 - To invoke the 'similar issue' tool from **CLI**, run:
 `python3 cli.py --issue_url=... similar_issue`
 
 - To invoke the 'similar' issue tool via online usage, [comment](https://github.com/Codium-ai/pr-agent/issues/178#issuecomment-1716934893) on a PR:
 `/similar_issue`
 
-- You can also enable the 'similar issue' tool to run automatically when a new issue is opened, by adding it to the [pr_commands list in the github_app section](https://github.com/Codium-ai/pr-agent/blob/main/pr_agent/settings/configuration.toml#L66)
+- You can also enable the 'similar issue' tool to run automatically when a new issue is opened, by adding it to the [pr_commands list in the github_app section](https://github.com/Codium-ai/pr-agent/blob/main/pr_agent/settings/configuration.toml#L66)

docs/docs/tools/test.md

@@ -0,0 +1,30 @@
+## Overview
+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`](./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>
+
+**Notes**
+- 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.

docs/docs/tools/update_changelog.md

@@ -1,5 +1,4 @@
-# Update Changelog Tool
+## Overview
-
 The `update_changelog` tool automatically updates the CHANGELOG.md file with the PR changes.
 It can be invoked manually by commenting on any PR:
 ```
@@ -8,12 +7,13 @@ It can be invoked manually by commenting on any PR:
 For example:
 
 <kbd><img src=https://codium.ai/images/pr_agent/update_changelog_comment.png width="768"></kbd>
+
 <kbd><img src=https://codium.ai/images/pr_agent/update_changelog.png width="768"></kbd>
 
 
-### Configuration options
+## Configuration options
 
-Under the section 'pr_update_changelog', the [configuration file](./../pr_agent/settings/configuration.toml#L50) contains options to customize the 'update changelog' tool:
+Under the section 'pr_update_changelog', the [configuration file](https://github.com/Codium-ai/pr-agent/blob/main/pr_agent/settings/configuration.toml#L50) contains options to customize the 'update changelog' tool:
 
 - `push_changelog_changes`: whether to push the changes to CHANGELOG.md, or just print them. Default is false (print only).
 - `extra_instructions`: Optional extra instructions to the tool. For example: "focus on the changes in the file X. Ignore change in ...

docs/docs/usage-guide/additional_configurations.md

@@ -0,0 +1,218 @@
+## Ignoring files from analysis
+
+In some cases, you may want to exclude specific files or directories from the analysis performed by CodiumAI PR-Agent. This can be useful, for example, when you have files that are generated automatically or files that shouldn't be reviewed, like vendored code.
+
+To ignore files or directories, edit the **[ignore.toml](https://github.com/Codium-ai/pr-agent/blob/main/pr_agent/settings/ignore.toml)** configuration file. This setting also exposes the following environment variables:
+
+ - `IGNORE.GLOB`
+ - `IGNORE.REGEX`
+
+For example, to ignore python files in a PR with online usage, comment on a PR:
+`/review --ignore.glob=['*.py']`
+
+To ignore python files in all PRs, set in a configuration file:
+```
+[ignore]
+glob = ['*.py']
+```
+
+## Extra instructions
+
+All PR-Agent tools have a parameter called `extra_instructions`, that enables to add free-text extra instructions. Example usage:
+```
+/update_changelog --pr_update_changelog.extra_instructions="Make sure to update also the version ..."
+```
+
+## Working with large PRs
+
+The default mode of CodiumAI is to have a single call per tool, using GPT-4, which has a token limit of 8000 tokens.
+This mode provide a very good speed-quality-cost tradeoff, and can handle most PRs successfully.
+When the PR is above the token limit, it employs a [PR Compression strategy](../core-abilities/index.md).
+
+However, for very large PRs, or in case you want to emphasize quality over speed and cost, there are 2 possible solutions:
+1) [Use a model](https://codium-ai.github.io/Docs-PR-Agent/usage-guide/#changing-a-model) with larger context, like GPT-32K, or claude-100K. This solution will be applicable for all the tools.
+2) For the `/improve` tool, there is an ['extended' mode](https://codium-ai.github.io/Docs-PR-Agent/tools/#improve) (`/improve --extended`),
+which divides the PR to chunks, and process each chunk separately. With this mode, regardless of the model, no compression will be done (but for large PRs, multiple model calls may occur)
+
+
+## Changing a model
+
+See [here](https://github.com/Codium-ai/pr-agent/blob/main/pr_agent/algo/__init__.py) for the list of available models.
+To use a different model than the default (GPT-4), you need to edit [configuration file](https://github.com/Codium-ai/pr-agent/blob/main/pr_agent/settings/configuration.toml#L2).
+For models and environments not from OPENAI, you might need to provide additional keys and other parameters. See below for instructions.
+
+### Azure
+
+To use Azure, set in your `.secrets.toml` (working from CLI), or in the GitHub `Settings > Secrets and variables` (working from GitHub App or GitHub Action):
+```
+[openai]
+key = "" # your azure api key
+api_type = "azure"
+api_version = '2023-05-15'  # Check Azure documentation for the current API version
+api_base = ""  # The base URL for your Azure OpenAI resource. e.g. "https://<your resource name>.openai.azure.com"
+deployment_id = ""  # The deployment name you chose when you deployed the engine
+```
+
+and set in your configuration file:
+```
+[config]
+model="" # the OpenAI model you've deployed on Azure (e.g. gpt-3.5-turbo)
+```
+
+### Huggingface
+
+**Local**
+You can run Huggingface models locally through either [VLLM](https://docs.litellm.ai/docs/providers/vllm) or [Ollama](https://docs.litellm.ai/docs/providers/ollama)
+
+E.g. to use a new Huggingface model locally via Ollama, set:
+```
+[__init__.py]
+MAX_TOKENS = {
+    "model-name-on-ollama": <max_tokens>
+}
+e.g.
+MAX_TOKENS={
+    ...,
+    "ollama/llama2": 4096
+}
+
+
+[config] # in configuration.toml
+model = "ollama/llama2"
+
+[ollama] # in .secrets.toml
+api_base = ... # the base url for your huggingface inference endpoint
+# e.g. if running Ollama locally, you may use:
+api_base = "http://localhost:11434/"
+```
+
+### Inference Endpoints
+
+To use a new model with Huggingface Inference Endpoints, for example, set:
+```
+[__init__.py]
+MAX_TOKENS = {
+    "model-name-on-huggingface": <max_tokens>
+}
+e.g.
+MAX_TOKENS={
+    ...,
+    "meta-llama/Llama-2-7b-chat-hf": 4096
+}
+[config] # in configuration.toml
+model = "huggingface/meta-llama/Llama-2-7b-chat-hf"
+
+[huggingface] # in .secrets.toml
+key = ... # your huggingface api key
+api_base = ... # the base url for your huggingface inference endpoint
+```
+(you can obtain a Llama2 key from [here](https://replicate.com/replicate/llama-2-70b-chat/api))
+
+### Replicate
+
+To use Llama2 model with Replicate, for example, set:
+```
+[config] # in configuration.toml
+model = "replicate/llama-2-70b-chat:2c1608e18606fad2812020dc541930f2d0495ce32eee50074220b87300bc16e1"
+[replicate] # in .secrets.toml
+key = ...
+```
+(you can obtain a Llama2 key from [here](https://replicate.com/replicate/llama-2-70b-chat/api))
+
+
+Also review the [AiHandler](https://github.com/Codium-ai/pr-agent/blob/main/pr_agent/algo/ai_handler.py) file for instruction how to set keys for other models.
+
+### Vertex AI
+
+To use Google's Vertex AI platform and its associated models (chat-bison/codechat-bison) set:
+
+``` 
+[config] # in configuration.toml
+model = "vertex_ai/codechat-bison"
+fallback_models="vertex_ai/codechat-bison"
+
+[vertexai] # in .secrets.toml
+vertex_project = "my-google-cloud-project"
+vertex_location = ""
+```
+
+Your [application default credentials](https://cloud.google.com/docs/authentication/application-default-credentials) will be used for authentication so there is no need to set explicit credentials in most environments.
+
+If you do want to set explicit credentials then you can use the `GOOGLE_APPLICATION_CREDENTIALS` environment variable set to a path to a json credentials file.
+
+### Anthropic
+
+To use Anthropic models, set the relevant models in the configuration section of the configuration file:
+```
+[config]
+model="anthropic/claude-3-opus-20240229"
+model_turbo="anthropic/claude-3-opus-20240229"
+fallback_models=["anthropic/claude-3-opus-20240229"]
+```
+
+And also set the api key in the .secrets.toml file:
+```
+[anthropic]
+KEY = "..."
+```
+
+### Amazon Bedrock
+
+To use Amazon Bedrock and its foundational models, add the below configuration:
+
+``` 
+[config] # in configuration.toml
+model = "anthropic.claude-v2"
+fallback_models="anthropic.claude-instant-v1"
+
+[aws] # in .secrets.toml
+bedrock_region = "us-east-1"
+```
+
+Note that you have to add access to foundational models before using them. Please refer to [this document](https://docs.aws.amazon.com/bedrock/latest/userguide/setting-up.html) for more details.
+
+AWS session is automatically authenticated from your environment, but you can also explicitly set `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY` environment variables.
+
+
+## Patch Extra Lines
+
+By default, around any change in your PR, git patch provides 3 lines of context above and below the change.
+```
+@@ -12,5 +12,5 @@ def func1():
+ code line that already existed in the file...
+ code line that already existed in the file...
+ code line that already existed in the file....
+-code line that was removed in the PR
++new code line added in the PR
+ code line that already existed in the file...
+ code line that already existed in the file...
+ code line that already existed in the file...
+```
+
+For the `review`, `describe`, `ask` and `add_docs` tools, if the token budget allows, PR-Agent tries to increase the number of lines of context, via the parameter:
+```
+[config]
+patch_extra_lines=3
+```
+
+Increasing this number provides more context to the model, but will also increase the token budget.
+If the PR is too large (see [PR Compression strategy](https://github.com/Codium-ai/pr-agent/blob/main/PR_COMPRESSION.md)), PR-Agent automatically sets this number to 0, using the original git patch.
+
+
+## Editing the prompts
+
+The prompts for the various PR-Agent tools are defined in the `pr_agent/settings` folder.
+In practice, the prompts are loaded and stored as a standard setting object.
+Hence, editing them is similar to editing any other configuration value - just place the relevant key in `.pr_agent.toml`file, and override the default value.
+
+For example, if you want to edit the prompts of the [describe](https://github.com/Codium-ai/pr-agent/blob/main/pr_agent/settings/pr_description_prompts.toml) tool, you can add the following to your `.pr_agent.toml` file:
+```
+[pr_description_prompt]
+system="""
+...
+"""
+user="""
+...
+"""
+```
+Note that the new prompt will need to generate an output compatible with the relevant [post-process function](https://github.com/Codium-ai/pr-agent/blob/main/pr_agent/tools/pr_description.py#L137).

docs/docs/usage-guide/automations_and_usage.md

@@ -0,0 +1,200 @@
+## Local repo (CLI)
+When running from your local repo (CLI), your local configuration file will be used.
+Examples of invoking the different tools via the CLI:
+
+- **Review**:       `python -m pr_agent.cli --pr_url=<pr_url>  review`
+- **Describe**:     `python -m pr_agent.cli --pr_url=<pr_url>  describe`
+- **Improve**:      `python -m pr_agent.cli --pr_url=<pr_url>  improve`
+- **Ask**:          `python -m pr_agent.cli --pr_url=<pr_url>  ask "Write me a poem about this PR"`
+- **Reflect**:      `python -m pr_agent.cli --pr_url=<pr_url>  reflect`
+- **Update Changelog**:      `python -m pr_agent.cli --pr_url=<pr_url>  update_changelog`
+
+`<pr_url>` is the url of the relevant PR (for example: [#50](https://github.com/Codium-ai/pr-agent/pull/50)).
+
+**Notes:**
+
+(1) in addition to editing your local configuration file, you can also change any configuration value by adding it to the command line:
+```
+python -m pr_agent.cli --pr_url=<pr_url>  /review --pr_reviewer.extra_instructions="focus on the file: ..."
+```
+
+(2) You can print results locally, without publishing them, by setting in `configuration.toml`:
+```
+[config]
+publish_output=false
+verbosity_level=2
+```
+This is useful for debugging or experimenting with different tools.
+
+
+### Online usage
+
+Online usage means invoking PR-Agent tools by [comments](https://github.com/Codium-ai/pr-agent/pull/229#issuecomment-1695021901) on a PR.
+Commands for invoking the different tools via comments:
+
+- **Review**:       `/review`
+- **Describe**:     `/describe`
+- **Improve**:      `/improve`
+- **Ask**:          `/ask "..."`
+- **Reflect**:      `/reflect`
+- **Update Changelog**:      `/update_changelog`
+
+
+To edit a specific configuration value, just add `--config_path=<value>` to any command.
+For example, if you want to edit the `review` tool configurations, you can run:
+```
+/review --pr_reviewer.extra_instructions="..." --pr_reviewer.require_score_review=false
+```
+Any configuration value in [configuration file](https://github.com/Codium-ai/pr-agent/blob/main/pr_agent/settings/configuration.toml) file can be similarly edited. Comment `/config` to see the list of available configurations.
+
+
+## GitHub App
+
+### GitHub app automatic tools when a new PR is opened
+
+The [github_app](https://github.com/Codium-ai/pr-agent/blob/main/pr_agent/settings/configuration.toml#L108) section defines GitHub app specific configurations.  
+
+The configuration parameter `pr_commands` defines the list of tools that will be **run automatically** when a new PR is opened.
+```
+[github_app]
+pr_commands = [
+    "/describe --pr_description.add_original_user_description=true --pr_description.keep_original_user_title=true --pr_description.final_update_message=false",
+    "/review --pr_reviewer.num_code_suggestions=0 --pr_reviewer.final_update_message=false",
+    "/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.  
+For the `describe` tool, for example, the `add_original_user_description` and `keep_original_user_title` parameters will be set to true.
+
+You can override the default tool parameters by using one the three options for a [configuration file](https://codium-ai.github.io/Docs-PR-Agent/usage-guide/#configuration-options): **wiki**, **local**, or **global**. 
+For example, if your local `.pr_agent.toml` file contains:
+```
+[pr_description]
+add_original_user_description = false
+keep_original_user_title = false
+```
+When a new PR is opened, PR-Agent will run the `describe` tool with the above parameters.
+
+To cancel the automatic run of all the tools, set:
+```
+[github_app]
+handle_pr_actions = []
+```
+
+You can also disable automatic runs for PRs with specific titles, by setting the `ignore_pr_titles` parameter with the relevant regex. For example:
+```
+[github_app]
+ignore_pr_title = ["^[Auto]", ".*ignore.*"]
+```
+will ignore PRs with titles that start with "Auto" or contain the word "ignore".
+
+### GitHub app automatic tools for push actions (commits 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 parameter `push_commands` defines the list of tools that will be **run automatically** when new code is pushed to the PR.
+```
+[github_app]
+handle_push_trigger = true
+push_commands = [
+    "/describe --pr_description.add_original_user_description=true --pr_description.keep_original_user_title=true",
+    "/review  --pr_reviewer.num_code_suggestions=0",
+]
+```
+This means that when new code is pushed to the PR, the PR-Agent will run the `describe` and `review` tools, with the specified parameters.
+
+## 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 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:
+```yaml
+      env:
+        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_action_config.auto_review: "true" # enable\disable auto review
+        github_action_config.auto_describe: "true" # enable\disable auto describe
+        github_action_config.auto_improve: "true" # 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.
+If not set, the default configuration is for all three tools to 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.
+
+For example, you can set an environment variable: `pr_description.add_original_user_description=false`, or add a `.pr_agent.toml` file with the following content:
+```
+[pr_description]
+add_original_user_description = false
+```
+
+## GitLab Webhook
+After setting up a GitLab webhook, to control which commands will run automatically when a new PR is opened, you can set the `pr_commands` parameter in the configuration file, similar to the GitHub App:
+```
+[gitlab]
+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",
+]
+```
+
+## BitBucket App
+Similar to GitHub app, when running PR-Agent from BitBucket App, the default [configuration file](https://github.com/Codium-ai/pr-agent/blob/main/pr_agent/settings/configuration.toml) from a pre-built docker will be initially loaded.
+
+By uploading a local `.pr_agent.toml` file to the root of the repo's main branch, you can edit and customize any configuration parameter. Note that you need to upload `.pr_agent.toml` prior to creating a PR, in order for the configuration to take effect.
+
+For example, if your local `.pr_agent.toml` file contains:
+```
+[pr_reviewer]
+inline_code_comments = true
+```
+
+Each time you invoke a `/review` tool, it will use inline code comments.
+
+### BitBucket Self-Hosted App automatic tools
+
+to control which commands will run automatically when a new PR is opened, you can set the `pr_commands` parameter in the configuration file:
+Specifically, set the following values:
+
+[bitbucket_app]
+```
+pr_commands = [
+    "/review --pr_reviewer.num_code_suggestions=0",
+    "/improve --pr_code_suggestions.summarize=false",
+]
+```
+
+## Azure DevOps provider
+
+To use Azure DevOps provider use the following settings in configuration.toml:
+```
+[config]
+git_provider="azure"
+use_repo_settings_file=false
+```
+
+Azure DevOps provider supports [PAT token](https://learn.microsoft.com/en-us/azure/devops/organizations/accounts/use-personal-access-tokens-to-authenticate?view=azure-devops&tabs=Windows) or [DefaultAzureCredential](https://learn.microsoft.com/en-us/azure/developer/python/sdk/authentication-overview#authentication-in-server-environments) authentication.
+PAT is faster to create, but has build in experation date, and will use the user identity for API calls. 
+Using DefaultAzureCredential you can use managed identity or Service principle, which are more secure and will create seperate ADO user identity (via AAD) to the agent.
+
+If PAT was choosen, you can assign the value in .secrets.toml. 
+If DefaultAzureCredential was choosen, you can assigned the additional env vars like AZURE_CLIENT_SECRET directly, 
+or use managed identity/az cli (for local develpment) without any additional configuration.
+in any case, 'org' value must be assigned in .secrets.toml:
+```
+[azure_devops]
+org = "https://dev.azure.com/YOUR_ORGANIZATION/"
+# pat = "YOUR_PAT_TOKEN" needed only if using PAT for authentication
+```
+
+### Azure DevOps Webhook
+
+To control which commands will run automatically when a new PR is opened, you can set the `pr_commands` parameter in the configuration file, similar to the GitHub App:
+```
+[azure_devops_server]
+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",
+]
+```

docs/docs/usage-guide/configuration_options.md

@@ -0,0 +1,56 @@
+The different tools and sub-tools used by CodiumAI PR-Agent are adjustable via the **[configuration file](https://github.com/Codium-ai/pr-agent/blob/main/pr_agent/settings/configuration.toml)**.
+
+In addition to general configuration options, each tool has its own configurations. For example, the `review` tool will use parameters from the [pr_reviewer](https://github.com/Codium-ai/pr-agent/blob/main/pr_agent/settings/configuration.toml#L16) section in the configuration file.
+See the [Tools Guide](https://codium-ai.github.io/Docs-PR-Agent/tools/) for a detailed description of the different tools and their configurations.
+
+There are three ways to set persistent configurations:
+
+1. Wiki configuration page 💎
+2. Local configuration file
+3. Global configuration file 💎
+
+In terms of precedence, wiki configurations will override local configurations, and local configurations will override global configurations.
+
+## Wiki configuration file 💎
+
+Specifically for GitHub, with PR-Agent-Pro you can set configurations by creating a page called `.pr_agent.toml` in the [wiki](https://github.com/Codium-ai/pr-agent/wiki/pr_agent.toml) of the repo. 
+The advantage of this method is that it allows to set configurations without needing to commit new content to the repo - just edit the wiki page and **save**.
+
+<kbd><img src="https://codium.ai/images/pr_agent/wiki_configuration.png" width="512"></kbd>
+
+Click [here](https://codium.ai/images/pr_agent/wiki_configuration_pr_agent.mp4) to see a short instructional video. We recommend surrounding the configuration content with triple-quotes, to allow better presentation when displayed in the wiki as markdown.
+An example content:
+
+```
+[pr_description] # /describe #
+keep_original_user_title=false
+```
+
+PR-Agent will know to remove the triple-quotes when reading the configuration content.
+
+## Local configuration file
+
+By uploading a local `.pr_agent.toml` file to the root of the repo's main branch, you can edit and customize any configuration parameter. Note that you need to upload `.pr_agent.toml` prior to creating a PR, in order for the configuration to take effect.
+
+For example, if you set in `.pr_agent.toml`:
+
+```
+[pr_reviewer]
+extra_instructions="""\
+- instruction a
+- instruction b
+...
+"""
+```
+
+Then you can give a list of extra instructions to the `review` tool.
+
+
+## Global configuration file 💎
+
+If you create a repo called `pr-agent-settings` in your **organization**, it's configuration file `.pr_agent.toml` will be used as a global configuration file for any other repo that belongs to the same organization.
+Parameters from a local `.pr_agent.toml` file, in a specific repo, will override the global configuration parameters.
+
+For example, in the GitHub organization `Codium-ai`:
+- The repo [`https://github.com/Codium-ai/pr-agent-settings`](https://github.com/Codium-ai/pr-agent-settings/blob/main/.pr_agent.toml) contains a `.pr_agent.toml` file that serves as a global configuration file for all the repos in the GitHub organization `Codium-ai`.
+- The repo [`https://github.com/Codium-ai/pr-agent`](https://github.com/Codium-ai/pr-agent/blob/main/.pr_agent.toml) inherits the global configuration file from `pr-agent-settings`.

docs/docs/usage-guide/index.md

@@ -0,0 +1,20 @@
+# Usage guide
+
+- [Introduction](./introduction.md)
+- [Configuration Options](./configuration_options.md)
+- [Managing Mail Notifications](./mail_notifications.md)
+- [Usage and Automation](./automations_and_usage.md)
+    - [Local Repo (CLI)](./automations_and_usage.md#local-repo-cli)
+    - [Online Usage](./automations_and_usage.md#online-usage)
+    - [GitHub App](./automations_and_usage.md#github-app)
+    - [GitHub Action](./automations_and_usage.md#github-action)
+    - [GitLab Webhook](./automations_and_usage.md#gitlab-webhook)
+    - [BitBucket App](./automations_and_usage.md#bitbucket-app)
+    - [Azure DevOps Provider](./automations_and_usage.md#azure-devops-provider)
+- [Additional Configurations Walkthrough](./additional_configurations.md)
+    - [Ignoring files from analysis](./additional_configurations.md#ignoring-files-from-analysis)
+    - [Extra instructions](./additional_configurations.md#extra-instructions)
+    - [Working with large PRs](./additional_configurations.md#working-with-large-prs)
+    - [Changing a model](./additional_configurations.md#changing-a-model)
+    - [Patch Extra Lines](./additional_configurations.md#patch-extra-lines)
+    - [Editing the prompts](./additional_configurations.md#editing-the-prompts)

docs/docs/usage-guide/introduction.md

@@ -0,0 +1,18 @@
+
+After [installation](https://codium-ai.github.io/Docs-PR-Agent/installation/), there are three basic ways to invoke CodiumAI PR-Agent:
+
+1. Locally running a CLI command
+2. Online usage - by [commenting](https://github.com/Codium-ai/pr-agent/pull/229#issuecomment-1695021901) on a PR
+3. Enabling PR-Agent tools to run automatically when a new PR is opened
+
+
+Specifically, CLI commands can be issued by invoking a pre-built [docker image](https://codium-ai.github.io/Docs-PR-Agent/installation/#run-from-source), or by invoking a [locally cloned repo](https://codium-ai.github.io/Docs-PR-Agent/installation/#locally).
+For online usage, you will need to setup either a [GitHub App](https://codium-ai.github.io/Docs-PR-Agent/installation/#run-as-a-github-app), or a [GitHub Action](https://codium-ai.github.io/Docs-PR-Agent/installation/#run-as-a-github-action).
+GitHub App and GitHub Action also enable to run PR-Agent specific tool automatically when a new PR is opened.
+
+
+**git provider**: The [git_provider](https://github.com/Codium-ai/pr-agent/blob/main/pr_agent/settings/configuration.toml#L4) field in the configuration file determines the GIT provider that will be used by PR-Agent. Currently, the following providers are supported:
+`
+"github", "gitlab", "bitbucket", "azure", "codecommit", "local", "gerrit"
+`
+

docs/docs/usage-guide/mail_notifications.md

@@ -0,0 +1,9 @@
+
+Unfortunately, it is not possible in GitHub to disable mail notifications from a specific user.
+If you are subscribed to notifications for a repo with PR-Agent, we recommend turning off notifications for PR comments, to avoid lengthy emails:
+
+<kbd><img src="https://codium.ai/images/pr_agent/notifications.png" width="512"></kbd>
+
+As an alternative, you can filter in your mail provider the notifications specifically from the PR-Agent bot, [see how](https://www.quora.com/How-can-you-filter-emails-for-specific-people-in-Gmail#:~:text=On%20the%20Filters%20and%20Blocked,the%20body%20of%20the%20email).
+
+<kbd><img src="https://codium.ai/images/pr_agent/filter_mail_notifications.png" width="512"></kbd>

docs/mkdocs.yml

@@ -0,0 +1,121 @@
+site_name: PR-Agent
+
+nav: 
+  - Overview: 'index.md'
+  - Installation: 
+    - 'installation/index.md'
+    - Locally: 'installation/locally.md'
+    - GitHub: 'installation/github.md'
+    - GitLab: 'installation/gitlab.md'
+    - BitBucket: 'installation/bitbucket.md'
+    - Azure DevOps: 'installation/azure.md'
+  - Usage Guide: 
+    - 'usage-guide/index.md'
+    - Introduction: 'usage-guide/introduction.md'
+    - Configuration Options: 'usage-guide/configuration_options.md'
+    - Managing email notifications: 'usage-guide/mail_notifications.md'
+    - Usage and Automation: 'usage-guide/automations_and_usage.md'
+    - Additional Configurations: 'usage-guide/additional_configurations.md'
+  - Tools: 
+    - 'tools/index.md'
+    - Describe: 'tools/describe.md'
+    - Review: 'tools/review.md'
+    - Improve: 'tools/improve.md'
+    - Ask: 'tools/ask.md'
+    - Update Changelog: 'tools/update_changelog.md'
+    - Similar Issues: 'tools/similar_issues.md'
+    - 💎 Analyze: 'tools/analyze.md'
+    - 💎 Test: 'tools/test.md'
+    - 💎 Documentation: 'tools/documentation.md'
+    - 💎 Custom Labels: 'tools/custom_labels.md'
+    - 💎 Custom Suggestions: 'tools/custom_suggestions.md'
+    - 💎 CI Feedback: 'tools/ci_feedback.md'
+    - 💎 Similar Code: 'tools/similar_code.md'
+  - Core Abilities: 'core-abilities/index.md'
+
+theme:
+  logo: assets/logo.png
+  favicon: assets/favicon.ico
+  name: material
+  features:
+    - navigation.tabs
+    - navigation.expand
+    - navigation.path
+    - navigation.top
+    - navigation.tracking
+    - navigation.indexes
+    - search.suggest
+    - search.highlight
+    - content.tabs.link
+    - content.code.annotation
+    - content.code.copy
+    - toc.integrate
+  language: en
+  custom_dir: overrides
+    
+  palette:
+    - media: "(prefers-color-scheme)"
+      toggle:
+        icon: material/brightness-auto
+        name: Switch to light mode
+    - media: "(prefers-color-scheme: light)"
+      scheme: default
+      toggle:
+        icon: material/toggle-switch-off-outline 
+        name: Switch to dark mode
+      primary: custom
+      accent: custom
+    - media: "(prefers-color-scheme: dark)"
+      scheme: slate 
+      toggle:
+        icon: material/toggle-switch
+        name: Switch to light mode    
+      primary: custom
+      accent: custom
+
+plugins:
+  - social
+  - search
+
+extra:
+  generator: false
+  social:
+    - icon: fontawesome/brands/github
+      link: https://github.com/Codium-ai
+    - icon: fontawesome/brands/discord
+      link: https://discord.com/invite/SgSxuQ65GF
+    - icon: fontawesome/brands/youtube
+      link: https://www.youtube.com/@Codium-AI
+    - icon: fontawesome/brands/linkedin
+      link: https://www.linkedin.com/company/codiumai
+    - icon: fontawesome/brands/twitter
+      link: https://twitter.com/CodiumAI
+    - icon: fontawesome/brands/instagram
+      link: https://www.instagram.com/codiumai/
+
+extra_css:
+  - css/custom.css
+
+markdown_extensions:
+  - pymdownx.highlight:
+      anchor_linenums: true
+  - pymdownx.inlinehilite
+  - pymdownx.snippets
+  - admonition
+  - pymdownx.arithmatex:
+      generic: true
+  - footnotes
+  - pymdownx.details
+  - pymdownx.superfences
+  - pymdownx.mark
+  - attr_list
+  - pymdownx.emoji:
+      emoji_index: !!python/name:material.extensions.emoji.twemoji
+      emoji_generator: !!python/name:materialx.emoji.to_svg
+  - toc:
+      title: On this page
+      toc_depth: 3
+      permalink: true
+  
+copyright: |
+  &copy; 2024 <a href="https://www.codium.ai/"  target="_blank" rel="noopener">CodiumAI</a>

docs/overrides/partials/footer.html

@@ -0,0 +1,100 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+<meta charset="UTF-8">
+<meta name="viewport" content="width=device-width, initial-scale=1.0">
+<title>Footer Customization</title>
+<style>
+  body {
+    margin: 0;
+    padding: 0;
+    font-family: Arial, sans-serif;
+    font-size: 16px;
+  }
+
+  .wrapper {
+    background-color: #171518;
+  }
+
+  .container {
+    display: flex;
+    flex-direction: row;
+    align-items: center;
+    justify-content: space-between;
+    color: white;
+    padding: 20px;
+    max-width: 61rem;
+    margin-left: auto;
+    margin-right: auto;
+  }
+  .footer-links {
+    display: flex;
+    justify-content: center;
+    gap: 20px;
+    margin: 10px 0;
+    
+  }
+  .footer-links, .social-icons {
+    padding: 0;
+    list-style-type: none;
+    display: flex;
+    justify-content: center;
+    gap: 20px;
+    align-items: center;
+  }
+  .footer-links a:hover {
+    color: #AEA1F1;
+  }
+  .social-icons {
+    display: flex;
+    gap: 20px;
+    align-items: center;
+  }
+  .social-icons a:hover {
+    color: #AEA1F1;
+  }
+  .social-icons svg {
+    width: 24px; 
+    height: auto;
+    fill: white;
+  }
+  .footer-text {
+    width: 240px;
+  }
+</style>
+</head>
+<body>
+
+<footer class="wrapper">
+  <div class="container">
+    <p class="footer-text">© 2024 <a href="https://www.codium.ai/" target="_blank" rel="noopener">CodiumAI</a></p>
+    <div class="footer-links">
+      <a href="https://codiumate-docs.codium.ai/">Codiumate</a>
+      <p>|</p>
+      <a href="https://alpha-codium-docs.codium.ai/">AlphaCodium</a>
+    </div>
+    <div class="social-icons">
+      <a href="https://github.com/Codium-ai" target="_blank" rel="noopener" title="github.com" class="social-link">
+        <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 496 512"><!--! Font Awesome Free 6.5.1 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M165.9 397.4c0 2-2.3 3.6-5.2 3.6-3.3.3-5.6-1.3-5.6-3.6 0-2 2.3-3.6 5.2-3.6 3-.3 5.6 1.3 5.6 3.6zm-31.1-4.5c-.7 2 1.3 4.3 4.3 4.9 2.6 1 5.6 0 6.2-2s-1.3-4.3-4.3-5.2c-2.6-.7-5.5.3-6.2 2.3zm44.2-1.7c-2.9.7-4.9 2.6-4.6 4.9.3 2 2.9 3.3 5.9 2.6 2.9-.7 4.9-2.6 4.6-4.6-.3-1.9-3-3.2-5.9-2.9zM244.8 8C106.1 8 0 113.3 0 252c0 110.9 69.8 205.8 169.5 239.2 12.8 2.3 17.3-5.6 17.3-12.1 0-6.2-.3-40.4-.3-61.4 0 0-70 15-84.7-29.8 0 0-11.4-29.1-27.8-36.6 0 0-22.9-15.7 1.6-15.4 0 0 24.9 2 38.6 25.8 21.9 38.6 58.6 27.5 72.9 20.9 2.3-16 8.8-27.1 16-33.7-55.9-6.2-112.3-14.3-112.3-110.5 0-27.5 7.6-41.3 23.6-58.9-2.6-6.5-11.1-33.3 2.6-67.9 20.9-6.5 69 27 69 27 20-5.6 41.5-8.5 62.8-8.5s42.8 2.9 62.8 8.5c0 0 48.1-33.6 69-27 13.7 34.7 5.2 61.4 2.6 67.9 16 17.7 25.8 31.5 25.8 58.9 0 96.5-58.9 104.2-114.8 110.5 9.2 7.9 17 22.9 17 46.4 0 33.7-.3 75.4-.3 83.6 0 6.5 4.6 14.4 17.3 12.1C428.2 457.8 496 362.9 496 252 496 113.3 383.5 8 244.8 8zM97.2 352.9c-1.3 1-1 3.3.7 5.2 1.6 1.6 3.9 2.3 5.2 1 1.3-1 1-3.3-.7-5.2-1.6-1.6-3.9-2.3-5.2-1zm-10.8-8.1c-.7 1.3.3 2.9 2.3 3.9 1.6 1 3.6.7 4.3-.7.7-1.3-.3-2.9-2.3-3.9-2-.6-3.6-.3-4.3.7zm32.4 35.6c-1.6 1.3-1 4.3 1.3 6.2 2.3 2.3 5.2 2.6 6.5 1 1.3-1.3.7-4.3-1.3-6.2-2.2-2.3-5.2-2.6-6.5-1zm-11.4-14.7c-1.6 1-1.6 3.6 0 5.9 1.6 2.3 4.3 3.3 5.6 2.3 1.6-1.3 1.6-3.9 0-6.2-1.4-2.3-4-3.3-5.6-2z"></path></svg>
+      </a>
+      <a href="https://discord.com/invite/SgSxuQ65GF" target="_blank" rel="noopener" title="discord.com" class="social-link">
+        <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 640 512"><!--! Font Awesome Free 6.5.1 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M524.531 69.836a1.5 1.5 0 0 0-.764-.7A485.065 485.065 0 0 0 404.081 32.03a1.816 1.816 0 0 0-1.923.91 337.461 337.461 0 0 0-14.9 30.6 447.848 447.848 0 0 0-134.426 0 309.541 309.541 0 0 0-15.135-30.6 1.89 1.89 0 0 0-1.924-.91 483.689 483.689 0 0 0-119.688 37.107 1.712 1.712 0 0 0-.788.676C39.068 183.651 18.186 294.69 28.43 404.354a2.016 2.016 0 0 0 .765 1.375 487.666 487.666 0 0 0 146.825 74.189 1.9 1.9 0 0 0 2.063-.676A348.2 348.2 0 0 0 208.12 430.4a1.86 1.86 0 0 0-1.019-2.588 321.173 321.173 0 0 1-45.868-21.853 1.885 1.885 0 0 1-.185-3.126 251.047 251.047 0 0 0 9.109-7.137 1.819 1.819 0 0 1 1.9-.256c96.229 43.917 200.41 43.917 295.5 0a1.812 1.812 0 0 1 1.924.233 234.533 234.533 0 0 0 9.132 7.16 1.884 1.884 0 0 1-.162 3.126 301.407 301.407 0 0 1-45.89 21.83 1.875 1.875 0 0 0-1 2.611 391.055 391.055 0 0 0 30.014 48.815 1.864 1.864 0 0 0 2.063.7A486.048 486.048 0 0 0 610.7 405.729a1.882 1.882 0 0 0 .765-1.352c12.264-126.783-20.532-236.912-86.934-334.541ZM222.491 337.58c-28.972 0-52.844-26.587-52.844-59.239s23.409-59.241 52.844-59.241c29.665 0 53.306 26.82 52.843 59.239 0 32.654-23.41 59.241-52.843 59.241Zm195.38 0c-28.971 0-52.843-26.587-52.843-59.239s23.409-59.241 52.843-59.241c29.667 0 53.307 26.82 52.844 59.239 0 32.654-23.177 59.241-52.844 59.241Z"></path></svg>
+      </a>
+      <a href="https://www.youtube.com/@Codium-AI" target="_blank" rel="noopener" title="www.youtube.com" class="social-link">
+        <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 576 512"><!--! Font Awesome Free 6.5.1 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M549.655 124.083c-6.281-23.65-24.787-42.276-48.284-48.597C458.781 64 288 64 288 64S117.22 64 74.629 75.486c-23.497 6.322-42.003 24.947-48.284 48.597-11.412 42.867-11.412 132.305-11.412 132.305s0 89.438 11.412 132.305c6.281 23.65 24.787 41.5 48.284 47.821C117.22 448 288 448 288 448s170.78 0 213.371-11.486c23.497-6.321 42.003-24.171 48.284-47.821 11.412-42.867 11.412-132.305 11.412-132.305s0-89.438-11.412-132.305zm-317.51 213.508V175.185l142.739 81.205-142.739 81.201z"></path></svg>
+      </a>
+      <a href="https://www.linkedin.com/company/codiumai" target="_blank" rel="noopener" title="www.linkedin.com" class="social-link">
+        <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.5.1 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M416 32H31.9C14.3 32 0 46.5 0 64.3v383.4C0 465.5 14.3 480 31.9 480H416c17.6 0 32-14.5 32-32.3V64.3c0-17.8-14.4-32.3-32-32.3zM135.4 416H69V202.2h66.5V416zm-33.2-243c-21.3 0-38.5-17.3-38.5-38.5S80.9 96 102.2 96c21.2 0 38.5 17.3 38.5 38.5 0 21.3-17.2 38.5-38.5 38.5zm282.1 243h-66.4V312c0-24.8-.5-56.7-34.5-56.7-34.6 0-39.9 27-39.9 54.9V416h-66.4V202.2h63.7v29.2h.9c8.9-16.8 30.6-34.5 62.9-34.5 67.2 0 79.7 44.3 79.7 101.9V416z"></path></svg>
+      </a>
+      <a href="https://twitter.com/CodiumAI" target="_blank" rel="noopener" title="twitter.com" class="social-link">
+        <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><!--! Font Awesome Free 6.5.1 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M459.37 151.716c.325 4.548.325 9.097.325 13.645 0 138.72-105.583 298.558-298.558 298.558-59.452 0-114.68-17.219-161.137-47.106 8.447.974 16.568 1.299 25.34 1.299 49.055 0 94.213-16.568 130.274-44.832-46.132-.975-84.792-31.188-98.112-72.772 6.498.974 12.995 1.624 19.818 1.624 9.421 0 18.843-1.3 27.614-3.573-48.081-9.747-84.143-51.98-84.143-102.985v-1.299c13.969 7.797 30.214 12.67 47.431 13.319-28.264-18.843-46.781-51.005-46.781-87.391 0-19.492 5.197-37.36 14.294-52.954 51.655 63.675 129.3 105.258 216.365 109.807-1.624-7.797-2.599-15.918-2.599-24.04 0-57.828 46.782-104.934 104.934-104.934 30.213 0 57.502 12.67 76.67 33.137 23.715-4.548 46.456-13.32 66.599-25.34-7.798 24.366-24.366 44.833-46.132 57.827 21.117-2.273 41.584-8.122 60.426-16.243-14.292 20.791-32.161 39.308-52.628 54.253z"></path></svg>
+      </a>
+      <a href="https://www.instagram.com/codiumai/" target="_blank" rel="noopener" title="www.instagram.com" class="social-link">
+        <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.5.1 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M224.1 141c-63.6 0-114.9 51.3-114.9 114.9s51.3 114.9 114.9 114.9S339 319.5 339 255.9 287.7 141 224.1 141zm0 189.6c-41.1 0-74.7-33.5-74.7-74.7s33.5-74.7 74.7-74.7 74.7 33.5 74.7 74.7-33.6 74.7-74.7 74.7zm146.4-194.3c0 14.9-12 26.8-26.8 26.8-14.9 0-26.8-12-26.8-26.8s12-26.8 26.8-26.8 26.8 12 26.8 26.8zm76.1 27.2c-1.7-35.9-9.9-67.7-36.2-93.9-26.2-26.2-58-34.4-93.9-36.2-37-2.1-147.9-2.1-184.9 0-35.8 1.7-67.6 9.9-93.9 36.1s-34.4 58-36.2 93.9c-2.1 37-2.1 147.9 0 184.9 1.7 35.9 9.9 67.7 36.2 93.9s58 34.4 93.9 36.2c37 2.1 147.9 2.1 184.9 0 35.9-1.7 67.7-9.9 93.9-36.2 26.2-26.2 34.4-58 36.2-93.9 2.1-37 2.1-147.8 0-184.8zM398.8 388c-7.8 19.6-22.9 34.7-42.6 42.6-29.5 11.7-99.5 9-132.1 9s-102.7 2.6-132.1-9c-19.6-7.8-34.7-22.9-42.6-42.6-11.7-29.5-9-99.5-9-132.1s-2.6-102.7 9-132.1c7.8-19.6 22.9-34.7 42.6-42.6 29.5-11.7 99.5-9 132.1-9s102.7-2.6 132.1 9c19.6 7.8 34.7 22.9 42.6 42.6 11.7 29.5 9 99.5 9 132.1s2.7 102.7-9 132.1z"></path></svg>
+      </a>
+    </div>
+  </div>
+</footer>
+
+</body>
+</html>

pr_agent/agent/pr_agent.py

@@ -1,14 +1,21 @@
 import shlex
+from functools import partial
+
+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.utils import update_settings_from_args
 from pr_agent.config_loader import get_settings
 from pr_agent.git_providers.utils import apply_repo_settings
+from pr_agent.log import get_logger
 from pr_agent.tools.pr_add_docs import PRAddDocs
 from pr_agent.tools.pr_code_suggestions import PRCodeSuggestions
 from pr_agent.tools.pr_config import PRConfig
 from pr_agent.tools.pr_description import PRDescription
 from pr_agent.tools.pr_generate_labels import PRGenerateLabels
+from pr_agent.tools.pr_help_message import PRHelpMessage
 from pr_agent.tools.pr_information_from_user import PRInformationFromUser
+from pr_agent.tools.pr_line_questions import PR_LineQuestions
 from pr_agent.tools.pr_questions import PRQuestions
 from pr_agent.tools.pr_reviewer import PRReviewer
 from pr_agent.tools.pr_similar_issue import PRSimilarIssue
@@ -27,9 +34,11 @@ command2class = {
     "improve_code": PRCodeSuggestions,
     "ask": PRQuestions,
     "ask_question": PRQuestions,
+    "ask_line": PR_LineQuestions,
     "update_changelog": PRUpdateChangelog,
     "config": PRConfig,
     "settings": PRConfig,
+    "help": PRHelpMessage,
     "similar_issue": PRSimilarIssue,
     "add_docs": PRAddDocs,
     "generate_labels": PRGenerateLabels,
@@ -38,8 +47,9 @@ command2class = {
 commands = list(command2class.keys())
 
 class PRAgent:
-    def __init__(self):
+    def __init__(self, ai_handler: partial[BaseAiHandler,] = LiteLLMAIHandler):
-        pass
+        self.ai_handler = ai_handler # will be initialized in run_action
+        self.forbidden_cli_args = ['enable_auto_approval']
 
     async def handle_request(self, pr_url, request, notify=None) -> bool:
         # First, apply repo specific settings if exists
@@ -53,22 +63,32 @@ class PRAgent:
             action, *args = list(lexer)
         else:
             action, *args = request
+
+        if args:
+            for forbidden_arg in self.forbidden_cli_args:
+                for arg in args:
+                    if forbidden_arg in arg:
+                        get_logger().error(f"CLI argument for param '{forbidden_arg}' is forbidden. Use instead a configuration file.")
+                        return False
         args = update_settings_from_args(args)
 
         action = action.lstrip("/").lower()
-        if action == "reflect_and_review":
+        with get_logger().contextualize(command=action):
-            get_settings().pr_reviewer.ask_and_reflect = True
+            get_logger().info("PR-Agent request handler started", analytics=True)
-        if action == "answer":
+            if action == "reflect_and_review":
-            if notify:
+                get_settings().pr_reviewer.ask_and_reflect = True
-                notify()
+            if action == "answer":
-            await PRReviewer(pr_url, is_answer=True, args=args).run()
+                if notify:
-        elif action == "auto_review":
+                    notify()
-            await PRReviewer(pr_url, is_auto=True, args=args).run()
+                await PRReviewer(pr_url, is_answer=True, args=args, ai_handler=self.ai_handler).run()
-        elif action in command2class:
+            elif action == "auto_review":
-            if notify:
+                await PRReviewer(pr_url, is_auto=True, args=args, ai_handler=self.ai_handler).run()
-                notify()
+            elif action in command2class:
-            await command2class[action](pr_url, args=args).run()
+                if notify:
-        else:
+                    notify()
-            return False
+
-        return True
+                await command2class[action](pr_url, ai_handler=self.ai_handler, args=args).run()
+            else:
+                return False
+            return True
 

pr_agent/algo/__init__.py

@@ -9,6 +9,7 @@ MAX_TOKENS = {
     'gpt-4-0613': 8000,
     'gpt-4-32k': 32000,
     'gpt-4-1106-preview': 128000, # 128K, but may be limited by config.max_model_tokens
+    'gpt-4-0125-preview': 128000,  # 128K, but may be limited by config.max_model_tokens
     'claude-instant-1': 100000,
     'claude-2': 100000,
     'command-nightly': 4096,
@@ -18,7 +19,8 @@ MAX_TOKENS = {
     'vertex_ai/codechat-bison-32k': 32000,
     'codechat-bison': 6144,
     'codechat-bison-32k': 32000,
-    'anthropic.claude-v2': 100000,
     'anthropic.claude-instant-v1': 100000,
     'anthropic.claude-v1': 100000,
+    'anthropic.claude-v2': 100000,
+    'anthropic/claude-3-opus-20240229': 100000,
 }

pr_agent/algo/ai_handlers/base_ai_handler.py

@@ -0,0 +1,28 @@
+from abc import ABC, abstractmethod
+
+class BaseAiHandler(ABC):
+    """
+    This class defines the interface for an AI handler to be used by the PR Agents.  
+    """
+
+    @abstractmethod
+    def __init__(self):
+        pass
+
+    @property
+    @abstractmethod
+    def deployment_id(self):
+        pass
+
+    @abstractmethod   
+    async def chat_completion(self, model: str, system: str, user: str, temperature: float = 0.2):
+        """
+        This method should be implemented to return a chat completion from the AI model.
+        Args:
+            model (str): the name of the model to use for the chat completion
+            system (str): the system message string to use for the chat completion
+            user (str): the user message string to use for the chat completion
+            temperature (float): the temperature to use for the chat completion    
+        """
+        pass
+

pr_agent/algo/ai_handlers/langchain_ai_handler.py

@@ -0,0 +1,67 @@
+try:
+    from langchain.chat_models import ChatOpenAI, AzureChatOpenAI
+    from langchain.schema import SystemMessage, HumanMessage
+except: # we don't enforce langchain as a dependency, so if it's not installed, just move on
+    pass
+
+from pr_agent.algo.ai_handlers.base_ai_handler import BaseAiHandler
+from pr_agent.config_loader import get_settings
+from pr_agent.log import get_logger
+
+from openai.error import APIError, RateLimitError, Timeout, TryAgain
+from retry import retry
+import functools
+
+OPENAI_RETRIES = 5
+
+class LangChainOpenAIHandler(BaseAiHandler):
+    def __init__(self):
+        # Initialize OpenAIHandler specific attributes here
+        super().__init__()
+        self.azure = get_settings().get("OPENAI.API_TYPE", "").lower() == "azure"
+        try:
+            if self.azure:
+                # using a partial function so we can set the deployment_id later to support fallback_deployments
+                # but still need to access the other settings now so we can raise a proper exception if they're missing
+                self._chat = functools.partial(
+                    lambda **kwargs: AzureChatOpenAI(**kwargs),
+                    openai_api_key=get_settings().openai.key,
+                    openai_api_base=get_settings().openai.api_base,
+                    openai_api_version=get_settings().openai.api_version,
+                )
+            else:
+                self._chat = ChatOpenAI(openai_api_key=get_settings().openai.key)
+        except AttributeError as e:
+            if getattr(e, "name"):
+                raise ValueError(f"OpenAI {e.name} is required") from e
+            else:
+                raise e
+    
+    @property
+    def chat(self):
+        if self.azure:
+            # we must set the deployment_id only here (instead of the __init__ method) to support fallback_deployments
+            return self._chat(deployment_name=self.deployment_id)
+        else:
+            return self._chat
+
+    @property
+    def deployment_id(self):
+        """
+        Returns the deployment ID for the OpenAI API.
+        """
+        return get_settings().get("OPENAI.DEPLOYMENT_ID", None)
+    @retry(exceptions=(APIError, Timeout, TryAgain, AttributeError, RateLimitError),
+           tries=OPENAI_RETRIES, delay=2, backoff=2, jitter=(1, 3))
+    async def chat_completion(self, model: str, system: str, user: str, temperature: float = 0.2):
+        try:
+            messages=[SystemMessage(content=system), HumanMessage(content=user)]
+            
+            # get a chat completion from the formatted messages
+            resp = self.chat(messages, model=model, temperature=temperature)
+            finish_reason="completed"
+            return resp.content, finish_reason
+        
+        except (Exception) as e:
+            get_logger().error("Unknown error during OpenAI inference: ", e)
+            raise e

pr_agent/algo/ai_handlers/litellm_ai_handler.py

@@ -4,15 +4,15 @@ import boto3
 import litellm
 import openai
 from litellm import acompletion
-from openai.error import APIError, RateLimitError, Timeout, TryAgain
+from tenacity import retry, retry_if_exception_type, stop_after_attempt
-from retry import retry
+from pr_agent.algo.ai_handlers.base_ai_handler import BaseAiHandler
 from pr_agent.config_loader import get_settings
 from pr_agent.log import get_logger
 
 OPENAI_RETRIES = 5
 
 
-class AiHandler:
+class LiteLLMAIHandler(BaseAiHandler):
     """
     This class handles interactions with the OpenAI API for chat completions.
     It initializes the API key and other settings from a configuration file,
@@ -26,7 +26,8 @@ class AiHandler:
         """
         self.azure = False
         self.aws_bedrock_client = None
-
+        self.api_base = None
+        self.repetition_penalty = None
         if get_settings().get("OPENAI.KEY", None):
             openai.api_key = get_settings().openai.key
             litellm.openai_key = get_settings().openai.key
@@ -55,8 +56,11 @@ class AiHandler:
             litellm.replicate_key = get_settings().replicate.key
         if get_settings().get("HUGGINGFACE.KEY", None):
             litellm.huggingface_key = get_settings().huggingface.key
-            if get_settings().get("HUGGINGFACE.API_BASE", None):
+        if get_settings().get("HUGGINGFACE.API_BASE", None) and 'huggingface' in get_settings().config.model:
-                litellm.api_base = get_settings().huggingface.api_base
+            litellm.api_base = get_settings().huggingface.api_base
+            self.api_base = get_settings().huggingface.api_base
+        if get_settings().get("HUGGINGFACE.REPITITION_PENALTY", None):
+            self.repetition_penalty = float(get_settings().huggingface.repetition_penalty)
         if get_settings().get("VERTEXAI.VERTEX_PROJECT", None):
             litellm.vertex_project = get_settings().vertexai.vertex_project
             litellm.vertex_location = get_settings().get(
@@ -76,35 +80,14 @@ class AiHandler:
         """
         return get_settings().get("OPENAI.DEPLOYMENT_ID", None)
 
-    @retry(exceptions=(APIError, Timeout, TryAgain, AttributeError, RateLimitError),
+    @retry(
-           tries=OPENAI_RETRIES, delay=2, backoff=2, jitter=(1, 3))
+        retry=retry_if_exception_type((openai.APIError, openai.APIConnectionError, openai.Timeout)), # No retry on RateLimitError
+        stop=stop_after_attempt(OPENAI_RETRIES)
+    )
     async def chat_completion(self, model: str, system: str, user: str, temperature: float = 0.2):
-        """
-        Performs a chat completion using the OpenAI ChatCompletion API.
-        Retries in case of API errors or timeouts.
-        
-        Args:
-            model (str): The model to use for chat completion.
-            temperature (float): The temperature parameter for chat completion.
-            system (str): The system message for chat completion.
-            user (str): The user message for chat completion.
-        
-        Returns:
-            tuple: A tuple containing the response and finish reason from the API.
-        
-        Raises:
-            TryAgain: If the API response is empty or there are no choices in the response.
-            APIError: If there is an error during OpenAI inference.
-            Timeout: If there is a timeout during OpenAI inference.
-            TryAgain: If there is an attribute error during OpenAI inference.
-        """
         try:
+            resp, finish_reason = None, None
             deployment_id = self.deployment_id
-            if get_settings().config.verbosity_level >= 2:
-                get_logger().debug(
-                    f"Generating completion with {model}"
-                    f"{(' from deployment ' + deployment_id) if deployment_id else ''}"
-                )
             if self.azure:
                 model = 'azure/' + model
             messages = [{"role": "system", "content": system}, {"role": "user", "content": user}]
@@ -114,24 +97,39 @@ class AiHandler:
                 "messages": messages,
                 "temperature": temperature,
                 "force_timeout": get_settings().config.ai_timeout,
+                "api_base" : self.api_base,
             }
             if self.aws_bedrock_client:
                 kwargs["aws_bedrock_client"] = self.aws_bedrock_client
+            if self.repetition_penalty:
+                kwargs["repetition_penalty"] = self.repetition_penalty
+
+            get_logger().debug("Prompts", artifact={"system": system, "user": user})
+
+            if get_settings().config.verbosity_level >= 2:
+                get_logger().info(f"\nSystem prompt:\n{system}")
+                get_logger().info(f"\nUser prompt:\n{user}")
+
             response = await acompletion(**kwargs)
-        except (APIError, Timeout, TryAgain) as e:
+        except (openai.APIError, openai.Timeout) as e:
             get_logger().error("Error during OpenAI inference: ", e)
             raise
-        except (RateLimitError) as e:
+        except (openai.RateLimitError) as e:
             get_logger().error("Rate limit error during OpenAI inference: ", e)
             raise
         except (Exception) as e:
             get_logger().error("Unknown error during OpenAI inference: ", e)
-            raise TryAgain from e
+            raise openai.APIError from e
         if response is None or len(response["choices"]) == 0:
-            raise TryAgain
+            raise openai.APIError
-        resp = response["choices"][0]['message']['content']
+        else:
-        finish_reason = response["choices"][0]["finish_reason"]
+            resp = response["choices"][0]['message']['content']
-        usage = response.get("usage")
+            finish_reason = response["choices"][0]["finish_reason"]
-        get_logger().info("AI response", response=resp, messages=messages, finish_reason=finish_reason,
+            # usage = response.get("usage")
-                          model=model, usage=usage)
+            get_logger().debug(f"\nAI response:\n{resp}")
-        return resp, finish_reason
+            get_logger().debug("Full_response", artifact=response)
+
+            if get_settings().config.verbosity_level >= 2:
+                get_logger().info(f"\nAI response:\n{resp}")
+
+        return resp, finish_reason

pr_agent/algo/ai_handlers/openai_ai_handler.py

@@ -0,0 +1,67 @@
+from pr_agent.algo.ai_handlers.base_ai_handler import BaseAiHandler
+import openai
+from openai.error import APIError, RateLimitError, Timeout, TryAgain
+from retry import retry
+
+from pr_agent.config_loader import get_settings
+from pr_agent.log import get_logger
+
+OPENAI_RETRIES = 5
+
+
+class OpenAIHandler(BaseAiHandler):
+    def __init__(self):
+        # Initialize OpenAIHandler specific attributes here
+        try:
+            super().__init__()
+            openai.api_key = get_settings().openai.key
+            if get_settings().get("OPENAI.ORG", None):
+                openai.organization = get_settings().openai.org
+            if get_settings().get("OPENAI.API_TYPE", None):
+                if get_settings().openai.api_type == "azure":
+                    self.azure = True
+                    openai.azure_key = get_settings().openai.key
+            if get_settings().get("OPENAI.API_VERSION", None):
+                openai.api_version = get_settings().openai.api_version
+            if get_settings().get("OPENAI.API_BASE", None):
+                openai.api_base = get_settings().openai.api_base
+
+        except AttributeError as e:
+            raise ValueError("OpenAI key is required") from e
+    @property
+    def deployment_id(self):
+        """
+        Returns the deployment ID for the OpenAI API.
+        """
+        return get_settings().get("OPENAI.DEPLOYMENT_ID", None)
+    
+    @retry(exceptions=(APIError, Timeout, TryAgain, AttributeError, RateLimitError),
+           tries=OPENAI_RETRIES, delay=2, backoff=2, jitter=(1, 3))
+    async def chat_completion(self, model: str, system: str, user: str, temperature: float = 0.2):
+        try:
+            deployment_id = self.deployment_id
+            get_logger().info("System: ", system)
+            get_logger().info("User: ", user)
+            messages = [{"role": "system", "content": system}, {"role": "user", "content": user}]
+
+            chat_completion = await openai.ChatCompletion.acreate(
+                model=model,
+                deployment_id=deployment_id,
+                messages=messages,
+                temperature=temperature,
+            )
+            resp = chat_completion["choices"][0]['message']['content']
+            finish_reason = chat_completion["choices"][0]["finish_reason"]
+            usage = chat_completion.get("usage")
+            get_logger().info("AI response", response=resp, messages=messages, finish_reason=finish_reason,
+                            model=model, usage=usage)
+            return resp, finish_reason       
+        except (APIError, Timeout, TryAgain) as e:
+            get_logger().error("Error during OpenAI inference: ", e)
+            raise
+        except (RateLimitError) as e:
+            get_logger().error("Rate limit error during OpenAI inference: ", e)
+            raise
+        except (Exception) as e:
+            get_logger().error("Unknown error during OpenAI inference: ", e)
+            raise TryAgain from e        

pr_agent/algo/git_patch_processing.py

@@ -3,7 +3,7 @@ from __future__ import annotations
 import re
 
 from pr_agent.config_loader import get_settings
-from pr_agent.git_providers.git_provider import EDIT_TYPE
+from pr_agent.algo.types import EDIT_TYPE, FilePatchInfo
 from pr_agent.log import get_logger
 
 
@@ -181,7 +181,7 @@ __old hunk__
            ...
     """
     
-    patch_with_lines_str = f"\n\n## {file.filename}\n"
+    patch_with_lines_str = f"\n\n## file: '{file.filename.strip()}'\n"
     patch_lines = patch.splitlines()
     RE_HUNK_HEADER = re.compile(
         r"^@@ -(\d+)(?:,(\d+))? \+(\d+)(?:,(\d+))? @@[ ]?(.*)")
@@ -202,11 +202,11 @@ __old hunk__
                 if new_content_lines:
                     if prev_header_line:
                         patch_with_lines_str += f'\n{prev_header_line}\n'
-                    patch_with_lines_str += '__new hunk__\n'
+                    patch_with_lines_str = patch_with_lines_str.rstrip()+'\n__new hunk__\n'
                     for i, line_new in enumerate(new_content_lines):
                         patch_with_lines_str += f"{start2 + i} {line_new}\n"
                 if old_content_lines:
-                    patch_with_lines_str += '__old hunk__\n'
+                    patch_with_lines_str = patch_with_lines_str.rstrip()+'\n__old hunk__\n'
                     for line_old in old_content_lines:
                         patch_with_lines_str += f"{line_old}\n"
                 new_content_lines = []
@@ -236,12 +236,68 @@ __old hunk__
     if match and new_content_lines:
         if new_content_lines:
             patch_with_lines_str += f'\n{header_line}\n'
-            patch_with_lines_str += '\n__new hunk__\n'
+            patch_with_lines_str = patch_with_lines_str.rstrip()+ '\n__new hunk__\n'
             for i, line_new in enumerate(new_content_lines):
                 patch_with_lines_str += f"{start2 + i} {line_new}\n"
         if old_content_lines:
-            patch_with_lines_str += '\n__old hunk__\n'
+            patch_with_lines_str = patch_with_lines_str.rstrip() + '\n__old hunk__\n'
             for line_old in old_content_lines:
                 patch_with_lines_str += f"{line_old}\n"
 
     return patch_with_lines_str.rstrip()
+
+
+def extract_hunk_lines_from_patch(patch: str, file_name, line_start, line_end, side) -> tuple[str, str]:
+
+    patch_with_lines_str = f"\n\n## file: '{file_name.strip()}'\n\n"
+    selected_lines = ""
+    patch_lines = patch.splitlines()
+    RE_HUNK_HEADER = re.compile(
+        r"^@@ -(\d+)(?:,(\d+))? \+(\d+)(?:,(\d+))? @@[ ]?(.*)")
+    match = None
+    start1, size1, start2, size2 = -1, -1, -1, -1
+    skip_hunk = False
+    selected_lines_num = 0
+    for line in patch_lines:
+        if 'no newline at end of file' in line.lower():
+            continue
+
+        if line.startswith('@@'):
+            skip_hunk = False
+            selected_lines_num = 0
+            header_line = line
+
+            match = RE_HUNK_HEADER.match(line)
+
+            res = list(match.groups())
+            for i in range(len(res)):
+                if res[i] is None:
+                    res[i] = 0
+            try:
+                start1, size1, start2, size2 = map(int, res[:4])
+            except:  # '@@ -0,0 +1 @@' case
+                start1, size1, size2 = map(int, res[:3])
+                start2 = 0
+
+            # check if line range is in this hunk
+            if side.lower() == 'left':
+                # check if line range is in this hunk
+                if not (start1 <= line_start <= start1 + size1):
+                    skip_hunk = True
+                    continue
+            elif side.lower() == 'right':
+                if not (start2 <= line_start <= start2 + size2):
+                    skip_hunk = True
+                    continue
+            patch_with_lines_str += f'\n{header_line}\n'
+
+        elif not skip_hunk:
+            if side.lower() == 'right' and line_start <= start2 + selected_lines_num <= line_end:
+                selected_lines += line + '\n'
+            if side.lower() == 'left' and start1 <= selected_lines_num + start1 <= line_end:
+                selected_lines += line + '\n'
+            patch_with_lines_str += line + '\n'
+            if not line.startswith('-'): # currently we don't support /ask line for deleted lines
+                selected_lines_num += 1
+
+    return patch_with_lines_str.rstrip(), selected_lines.rstrip()

pr_agent/algo/pr_processing.py

@@ -1,9 +1,7 @@
 from __future__ import annotations
 
-import difflib
-import re
 import traceback
-from typing import Any, Callable, List, Tuple
+from typing import Callable, List, Tuple
 
 from github import RateLimitExceededException
 
@@ -11,9 +9,10 @@ from pr_agent.algo.git_patch_processing import convert_to_hunks_with_lines_numbe
 from pr_agent.algo.language_handler import sort_files_by_main_languages
 from pr_agent.algo.file_filter import filter_ignored
 from pr_agent.algo.token_handler import TokenHandler
-from pr_agent.algo.utils import get_max_tokens
+from pr_agent.algo.utils import get_max_tokens, ModelType
 from pr_agent.config_loader import get_settings
-from pr_agent.git_providers.git_provider import FilePatchInfo, GitProvider, EDIT_TYPE
+from pr_agent.git_providers.git_provider import GitProvider
+from pr_agent.algo.types import EDIT_TYPE, FilePatchInfo
 from pr_agent.log import get_logger
 
 DELETED_FILES_ = "Deleted files:\n"
@@ -51,15 +50,29 @@ def get_pr_diff(git_provider: GitProvider, token_handler: TokenHandler, model: s
         PATCH_EXTRA_LINES = get_settings().config.patch_extra_lines
 
     try:
-        diff_files = git_provider.get_diff_files()
+        diff_files_original = git_provider.get_diff_files()
     except RateLimitExceededException as e:
         get_logger().error(f"Rate limit exceeded for git provider API. original message {e}")
         raise
 
-    diff_files = filter_ignored(diff_files)
+    diff_files = filter_ignored(diff_files_original)
+    if diff_files != diff_files_original:
+        try:
+            get_logger().info(f"Filtered out {len(diff_files_original) - len(diff_files)} files")
+            new_names = set([a.filename for a in diff_files])
+            orig_names = set([a.filename for a in diff_files_original])
+            get_logger().info(f"Filtered out files: {orig_names - new_names}")
+        except Exception as e:
+            pass
+
 
     # get pr languages
     pr_languages = sort_files_by_main_languages(git_provider.get_languages(), diff_files)
+    if pr_languages:
+        try:
+            get_logger().info(f"PR main language: {pr_languages[0]['language']}")
+        except Exception as e:
+            pass
 
     # generate a standard diff string, with patch extension
     patches_extended, total_tokens, patches_extended_tokens = pr_generate_extended_diff(
@@ -67,9 +80,13 @@ def get_pr_diff(git_provider: GitProvider, token_handler: TokenHandler, model: s
 
     # if we are under the limit, return the full diff
     if total_tokens + OUTPUT_BUFFER_TOKENS_SOFT_THRESHOLD < get_max_tokens(model):
+        get_logger().info(f"Tokens: {total_tokens}, total tokens under limit: {get_max_tokens(model)}, "
+                          f"returning full diff.")
         return "\n".join(patches_extended)
 
     # if we are over the limit, start pruning
+    get_logger().info(f"Tokens: {total_tokens}, total tokens over limit: {get_max_tokens(model)}, "
+                      f"pruning diff.")
     patches_compressed, modified_file_names, deleted_file_names, added_file_names = \
         pr_generate_compressed_diff(pr_languages, token_handler, model, add_line_numbers_to_hunks)
 
@@ -83,6 +100,11 @@ def get_pr_diff(git_provider: GitProvider, token_handler: TokenHandler, model: s
     if deleted_file_names:
         deleted_list_str = DELETED_FILES_ + "\n".join(deleted_file_names)
         final_diff = final_diff + "\n\n" + deleted_list_str
+    try:
+        get_logger().debug(f"After pruning, added_list_str: {added_list_str}, modified_list_str: {modified_list_str}, "
+                          f"deleted_list_str: {deleted_list_str}")
+    except Exception as e:
+        pass
     return final_diff
 
 
@@ -209,9 +231,9 @@ def pr_generate_compressed_diff(top_langs: list, token_handler: TokenHandler, mo
 
         if patch:
             if not convert_hunks_to_line_numbers:
-                patch_final = f"## {file.filename}\n\n{patch}\n"
+                patch_final = f"\n\n## file: '{file.filename.strip()}\n\n{patch.strip()}\n'"
             else:
-                patch_final = patch
+                patch_final = "\n\n" + patch.strip()
             patches.append(patch_final)
             total_tokens += token_handler.count_tokens(patch_final)
             if get_settings().config.verbosity_level >= 2:
@@ -220,15 +242,19 @@ def pr_generate_compressed_diff(top_langs: list, token_handler: TokenHandler, mo
     return patches, modified_files_list, deleted_files_list, added_files_list
 
 
-async def retry_with_fallback_models(f: Callable):
+async def retry_with_fallback_models(f: Callable, model_type: ModelType = ModelType.REGULAR):
-    all_models = _get_all_models()
+    all_models = _get_all_models(model_type)
     all_deployments = _get_all_deployments(all_models)
     # try each (model, deployment_id) pair until one is successful, otherwise raise exception
     for i, (model, deployment_id) in enumerate(zip(all_models, all_deployments)):
         try:
+            get_logger().debug(
+                f"Generating prediction with {model}"
+                f"{(' from deployment ' + deployment_id) if deployment_id else ''}"
+            )
             get_settings().set("openai.deployment_id", deployment_id)
             return await f(model)
-        except Exception as e:
+        except:
             get_logger().warning(
                 f"Failed to generate prediction with {model}"
                 f"{(' from deployment ' + deployment_id) if deployment_id else ''}: "
@@ -238,8 +264,11 @@ async def retry_with_fallback_models(f: Callable):
                 raise  # Re-raise the last exception
 
 
-def _get_all_models() -> List[str]:
+def _get_all_models(model_type: ModelType = ModelType.REGULAR) -> List[str]:
-    model = get_settings().config.model
+    if model_type == ModelType.TURBO:
+        model = get_settings().config.model_turbo
+    else:
+        model = get_settings().config.model
     fallback_models = get_settings().config.fallback_models
     if not isinstance(fallback_models, list):
         fallback_models = [m.strip() for m in fallback_models.split(",")]
@@ -262,70 +291,6 @@ def _get_all_deployments(all_models: List[str]) -> List[str]:
     return all_deployments
 
 
-def find_line_number_of_relevant_line_in_file(diff_files: List[FilePatchInfo],
-                                              relevant_file: str,
-                                              relevant_line_in_file: str) -> Tuple[int, int]:
-    """
-    Find the line number and absolute position of a relevant line in a file.
-
-    Args:
-        diff_files (List[FilePatchInfo]): A list of FilePatchInfo objects representing the patches of files.
-        relevant_file (str): The name of the file where the relevant line is located.
-        relevant_line_in_file (str): The content of the relevant line.
-
-    Returns:
-        Tuple[int, int]: A tuple containing the line number and absolute position of the relevant line in the file.
-    """
-    position = -1
-    absolute_position = -1
-    re_hunk_header = re.compile(
-        r"^@@ -(\d+)(?:,(\d+))? \+(\d+)(?:,(\d+))? @@[ ]?(.*)")
-
-    for file in diff_files:
-        if file.filename and (file.filename.strip() == relevant_file):
-            patch = file.patch
-            patch_lines = patch.splitlines()
-
-            # try to find the line in the patch using difflib, with some margin of error
-            matches_difflib: list[str | Any] = difflib.get_close_matches(relevant_line_in_file,
-                                                                         patch_lines, n=3, cutoff=0.93)
-            if len(matches_difflib) == 1 and matches_difflib[0].startswith('+'):
-                relevant_line_in_file = matches_difflib[0]
-
-            delta = 0
-            start1, size1, start2, size2 = 0, 0, 0, 0
-            for i, line in enumerate(patch_lines):
-                if line.startswith('@@'):
-                    delta = 0
-                    match = re_hunk_header.match(line)
-                    start1, size1, start2, size2 = map(int, match.groups()[:4])
-                elif not line.startswith('-'):
-                    delta += 1
-
-                if relevant_line_in_file in line and line[0] != '-':
-                    position = i
-                    absolute_position = start2 + delta - 1
-                    break
-
-            if position == -1 and relevant_line_in_file[0] == '+':
-                no_plus_line = relevant_line_in_file[1:].lstrip()
-                for i, line in enumerate(patch_lines):
-                    if line.startswith('@@'):
-                        delta = 0
-                        match = re_hunk_header.match(line)
-                        start1, size1, start2, size2 = map(int, match.groups()[:4])
-                    elif not line.startswith('-'):
-                        delta += 1
-
-                    if no_plus_line in line and line[0] != '-':
-                        # The model might add a '+' to the beginning of the relevant_line_in_file even if originally
-                        # it's a context line
-                        position = i
-                        absolute_position = start2 + delta - 1
-                        break
-    return position, absolute_position
-
-
 def get_pr_multi_diffs(git_provider: GitProvider,
                        token_handler: TokenHandler,
                        model: str,
@@ -362,6 +327,13 @@ def get_pr_multi_diffs(git_provider: GitProvider,
     for lang in pr_languages:
         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 = []
     final_diff_list = []
     total_tokens = token_handler.prompt_tokens
@@ -385,6 +357,11 @@ def get_pr_multi_diffs(git_provider: GitProvider,
 
         patch = convert_to_hunks_with_lines_numbers(patch, file)
         new_patch_tokens = token_handler.count_tokens(patch)
+
+        if patch and (token_handler.prompt_tokens + new_patch_tokens) > get_max_tokens(model) - OUTPUT_BUFFER_TOKENS_SOFT_THRESHOLD:
+            get_logger().warning(f"Patch too large, skipping: {file.filename}")
+            continue
+
         if patch and (total_tokens + new_patch_tokens > get_max_tokens(model) - OUTPUT_BUFFER_TOKENS_SOFT_THRESHOLD):
             final_diff = "\n".join(patches)
             final_diff_list.append(final_diff)

pr_agent/algo/types.py

@@ -0,0 +1,23 @@
+from dataclasses import dataclass
+from enum import Enum
+
+
+class EDIT_TYPE(Enum):
+    ADDED = 1
+    DELETED = 2
+    MODIFIED = 3
+    RENAMED = 4
+    UNKNOWN = 5
+
+
+@dataclass
+class FilePatchInfo:
+    base_file: str
+    head_file: str
+    patch: str
+    filename: str
+    tokens: int = -1
+    edit_type: EDIT_TYPE = EDIT_TYPE.UNKNOWN
+    old_filename: str = None
+    num_plus_lines: int = -1
+    num_minus_lines: int = -1

pr_agent/algo/utils.py

@@ -5,7 +5,8 @@ import json
 import re
 import textwrap
 from datetime import datetime
-from typing import Any, List
+from enum import Enum
+from typing import Any, List, Tuple
 
 import yaml
 from starlette_context import context
@@ -13,8 +14,12 @@ from starlette_context import context
 from pr_agent.algo import MAX_TOKENS
 from pr_agent.algo.token_handler import get_token_encoder
 from pr_agent.config_loader import get_settings, global_settings
+from pr_agent.algo.types import FilePatchInfo
 from pr_agent.log import get_logger
 
+class ModelType(str, Enum):
+    REGULAR = "regular"
+    TURBO = "turbo"
 
 def get_setting(key: str) -> Any:
     try:
@@ -23,7 +28,39 @@ def get_setting(key: str) -> Any:
     except Exception:
         return global_settings.get(key, None)
 
-def convert_to_markdown(output_data: dict, gfm_supported: bool=True) -> str:
+
+def emphasize_header(text: str) -> str:
+    try:
+        # Finding the position of the first occurrence of ": "
+        colon_position = text.find(": ")
+
+        # Splitting the string and wrapping the first part in <strong> tags
+        if colon_position != -1:
+            # Everything before the colon (inclusive) is wrapped in <strong> tags
+            transformed_string = "<strong>" + text[:colon_position + 1] + "</strong>" + text[colon_position + 1:]
+        else:
+            # If there's no ": ", return the original string
+            transformed_string = text
+
+        return transformed_string
+    except Exception as e:
+        get_logger().exception(f"Failed to emphasize header: {e}")
+        return text
+
+
+def unique_strings(input_list: List[str]) -> List[str]:
+    if not input_list or not isinstance(input_list, list):
+        return input_list
+    seen = set()
+    unique_list = []
+    for item in input_list:
+        if item not in seen:
+            unique_list.append(item)
+            seen.add(item)
+    return unique_list
+
+
+def convert_to_markdown(output_data: dict, gfm_supported: bool = True, incremental_review=None) -> str:
     """
     Convert a dictionary of data into markdown format.
     Args:
@@ -31,84 +68,151 @@ def convert_to_markdown(output_data: dict, gfm_supported: bool=True) -> str:
     Returns:
         str: The markdown formatted text generated from the input dictionary.
     """    
-    markdown_text = ""
 
     emojis = {
-        "Main theme": "🎯",
+        "Possible issues": "🔍",
-        "PR summary": "📝",
-        "Type of PR": "📌",
         "Score": "🏅",
-        "Relevant tests added": "🧪",
+        "Relevant tests": "🧪",
-        "Unrelated changes": "⚠️",
         "Focused PR": "✨",
         "Security concerns": "🔒",
-        "General suggestions": "💡",
         "Insights from user's answers": "📝",
         "Code feedback": "🤖",
         "Estimated effort to review [1-5]": "⏱️",
     }
+    markdown_text = ""
+    if not incremental_review:
+        markdown_text += f"## PR Review\n\n"
+    else:
+        markdown_text += f"## Incremental PR Review\n\n"
+        markdown_text += f"⏮️ Review for commits since previous PR-Agent review {incremental_review}.\n\n"
+    if gfm_supported:
+        markdown_text += "<table>\n<tr>\n"
+        # markdown_text += """<td> &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Feedback&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</td> <td></td></tr>"""
 
-    for key, value in output_data.items():
+    if not output_data or not output_data.get('review', {}):
-        if value is None or value == '' or value == {}:
+        return ""
+
+    for key, value in output_data['review'].items():
+        if value is None or value == '' or value == {} or value == []:
             continue
-        if isinstance(value, dict):
+        key_nice = key.replace('_', ' ').capitalize()
-            markdown_text += f"## {key}\n\n"
+        emoji = emojis.get(key_nice, "")
-            markdown_text += convert_to_markdown(value, gfm_supported)
+        if gfm_supported:
-        elif isinstance(value, list):
+            if 'Estimated effort to review' in key_nice:
-            emoji = emojis.get(key, "")
+                key_nice = 'Estimated&nbsp;effort&nbsp;to&nbsp;review [1-5]'
-            if key.lower() == 'code feedback':
+            if 'security concerns' in key_nice.lower():
-                if gfm_supported:
+                value = emphasize_header(value.strip())
-                    markdown_text += f"\n\n- "
+                markdown_text += f"<tr><td> {emoji}&nbsp;<strong>{key_nice}</strong></td><td>\n\n{value}\n\n</td></tr>\n"
-                    markdown_text += f"<details><summary> { emoji } Code feedback:</summary>\n\n"
+            elif 'possible issues' in key_nice.lower():
+                value = value.strip()
+                issues = value.split('\n- ')
+                for i, _ in enumerate(issues):
+                    issues[i] = issues[i].strip().strip('-').strip()
+                issues = unique_strings(issues) # remove duplicates
+                number_of_issues = len(issues)
+                if number_of_issues > 1:
+                    markdown_text += f"<tr><td rowspan={number_of_issues}> {emoji}&nbsp;<strong>{key_nice}</strong></td>\n"
+                    for i, issue in enumerate(issues):
+                        if not issue:
+                            continue
+                        issue = emphasize_header(issue)
+                        if i == 0:
+                            markdown_text += f"<td>\n\n{issue}</td></tr>\n"
+                        else:
+                            markdown_text += f"<tr>\n<td>\n\n{issue}</td></tr>\n"
                 else:
-                    markdown_text += f"\n\n- **{emoji} Code feedback:**\n\n"
+                    value = emphasize_header(value.strip('-').strip())
+                    markdown_text += f"<tr><td> {emoji}&nbsp;<strong>{key_nice}</strong></td><td>\n\n{value}\n\n</td></tr>\n"
             else:
-                markdown_text += f"- {emoji} **{key}:**\n\n"
+                markdown_text += f"<tr><td> {emoji}&nbsp;<strong>{key_nice}</strong></td><td>\n\n{value}\n\n</td></tr>\n"
-            for item in value:
+        else:
-                if isinstance(item, dict) and key.lower() == 'code feedback':
+            if len(value.split()) > 1:
-                    markdown_text += parse_code_suggestion(item, gfm_supported)
+                markdown_text += f"{emoji} **{key_nice}:**\n\n {value}\n\n"
-                elif item:
+            else:
-                    markdown_text += f"  - {item}\n"
+                markdown_text += f"{emoji} **{key_nice}:** {value}\n\n"
-            if key.lower() == 'code feedback':
+    if gfm_supported:
-                if gfm_supported:
+        markdown_text += "</table>\n"
-                    markdown_text += "</details>\n\n"
+
-                else:
+    if 'code_feedback' in output_data:
-                    markdown_text += "\n\n"
+        if gfm_supported:
-        elif value != 'n/a':
+            markdown_text += f"\n\n"
-            emoji = emojis.get(key, "")
+            markdown_text += f"<details><summary> <strong>Code feedback:</strong></summary>\n\n"
-            markdown_text += f"- {emoji} **{key}:** {value}\n"
+            markdown_text += "<hr>"
+        else:
+            markdown_text += f"\n\n** Code feedback:**\n\n"
+        for i, value in enumerate(output_data['code_feedback']):
+            if value is None or value == '' or value == {} or value == []:
+                continue
+            markdown_text += parse_code_suggestion(value, i, gfm_supported)+"\n\n"
+        if markdown_text.endswith('<hr>'):
+            markdown_text = markdown_text[:-4]
+        if gfm_supported:
+            markdown_text += f"</details>"
+    #print(markdown_text)
+
+
     return markdown_text
 
 
-def parse_code_suggestion(code_suggestions: dict, gfm_supported: bool=True) -> str:
+def parse_code_suggestion(code_suggestion: dict, i: int = 0, gfm_supported: bool = True) -> str:
     """
     Convert a dictionary of data into markdown format.
 
     Args:
-        code_suggestions (dict): A dictionary containing data to be converted to markdown format.
+        code_suggestion (dict): A dictionary containing data to be converted to markdown format.
 
     Returns:
         str: A string containing the markdown formatted text generated from the input dictionary.
     """
     markdown_text = ""
-    for sub_key, sub_value in code_suggestions.items():
+    if gfm_supported and 'relevant_line' in code_suggestion:
-        if isinstance(sub_value, dict):  # "code example"
+        markdown_text += '<table>'
-            markdown_text += f"  - **{sub_key}:**\n"
+        for sub_key, sub_value in code_suggestion.items():
-            for code_key, code_value in sub_value.items():  # 'before' and 'after' code
+            try:
-                code_str = f"```\n{code_value}\n```"
+                if sub_key.lower() == 'relevant_file':
-                code_str_indented = textwrap.indent(code_str, '        ')
+                    relevant_file = sub_value.strip('`').strip('"').strip("'")
-                markdown_text += f"    - **{code_key}:**\n{code_str_indented}\n"
+                    markdown_text += f"<tr><td>relevant file</td><td>{relevant_file}</td></tr>"
-        else:
+                    # continue
-            if "relevant file" in sub_key.lower():
+                elif sub_key.lower() == 'suggestion':
-                markdown_text += f"\n  - **{sub_key}:** {sub_value}  \n"
+                    markdown_text += (f"<tr><td>{sub_key} &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</td>"
+                                      f"<td>\n\n<strong>\n\n{sub_value.strip()}\n\n</strong>\n</td></tr>")
+                elif sub_key.lower() == 'relevant_line':
+                    markdown_text += f"<tr><td>relevant line</td>"
+                    sub_value_list = sub_value.split('](')
+                    relevant_line = sub_value_list[0].lstrip('`').lstrip('[')
+                    if len(sub_value_list) > 1:
+                        link = sub_value_list[1].rstrip(')').strip('`')
+                        markdown_text += f"<td><a href='{link}'>{relevant_line}</a></td>"
+                    else:
+                        markdown_text += f"<td>{relevant_line}</td>"
+                    markdown_text += "</tr>"
+            except Exception as e:
+                get_logger().exception(f"Failed to parse code suggestion: {e}")
+                pass
+        markdown_text += '</table>'
+        markdown_text += "<hr>"
+    else:
+        for sub_key, sub_value in code_suggestion.items():
+            if isinstance(sub_key, str):
+                sub_key = sub_key.rstrip()
+            if isinstance(sub_value,str):
+                sub_value = sub_value.rstrip()
+            if isinstance(sub_value, dict):  # "code example"
+                markdown_text += f"  - **{sub_key}:**\n"
+                for code_key, code_value in sub_value.items():  # 'before' and 'after' code
+                    code_str = f"```\n{code_value}\n```"
+                    code_str_indented = textwrap.indent(code_str, '        ')
+                    markdown_text += f"    - **{code_key}:**\n{code_str_indented}\n"
             else:
-                markdown_text += f"   **{sub_key}:** {sub_value}  \n"
+                if "relevant_file" in sub_key.lower():
-            if not gfm_supported:
+                    markdown_text += f"\n  - **{sub_key}:** {sub_value}  \n"
-                if "relevant line" not in sub_key.lower(): # nicer presentation
+                else:
-                        # markdown_text = markdown_text.rstrip('\n') + "\\\n" # works for gitlab
+                    markdown_text += f"   **{sub_key}:** {sub_value}  \n"
-                        markdown_text = markdown_text.rstrip('\n') + "   \n"  # works for gitlab and bitbucker
+                if "relevant_line" not in sub_key.lower():  # nicer presentation
+                    # markdown_text = markdown_text.rstrip('\n') + "\\\n" # works for gitlab
+                    markdown_text = markdown_text.rstrip('\n') + "   \n"  # works for gitlab and bitbucker
 
-    markdown_text += "\n"
+        markdown_text += "\n"
     return markdown_text
 
 
@@ -288,19 +392,21 @@ def _fix_key_value(key: str, value: str):
     return key, value
 
 
-def load_yaml(response_text: str) -> dict:
+def load_yaml(response_text: str, keys_fix_yaml: List[str] = []) -> dict:
     response_text = response_text.removeprefix('```yaml').rstrip('`')
     try:
         data = yaml.safe_load(response_text)
     except Exception as e:
         get_logger().error(f"Failed to parse AI prediction: {e}")
-        data = try_fix_yaml(response_text)
+        data = try_fix_yaml(response_text, keys_fix_yaml=keys_fix_yaml)
     return data
 
-def try_fix_yaml(response_text: str) -> dict:
+
+def try_fix_yaml(response_text: str, keys_fix_yaml: List[str] = []) -> dict:
     response_text_lines = response_text.split('\n')
 
-    keys = ['relevant line:', 'suggestion content:', 'relevant file:']
+    keys = ['relevant line:', 'suggestion content:', 'relevant file:', 'existing code:', 'improved code:']
+    keys = keys + keys_fix_yaml
     # first fallback - try to convert 'relevant line: ...' to relevant line: |-\n        ...'
     response_text_lines_copy = response_text_lines.copy()
     for i in range(0, len(response_text_lines_copy)):
@@ -315,28 +421,40 @@ def try_fix_yaml(response_text: str) -> dict:
     except:
         get_logger().info(f"Failed to parse AI prediction after adding |-\n")
 
-    # second fallback - try to remove last lines
+    # second fallback - try to extract only range from first ```yaml to ````
-    data = {}
+    snippet_pattern = r'```(yaml)?[\s\S]*?```'
-    for i in range(1, len(response_text_lines)):
+    snippet = re.search(snippet_pattern, '\n'.join(response_text_lines_copy))
-        response_text_lines_tmp = '\n'.join(response_text_lines[:-i])
+    if snippet:
+        snippet_text = snippet.group()
         try:
-            data = yaml.safe_load(response_text_lines_tmp,)
+            data = yaml.safe_load(snippet_text.removeprefix('```yaml').rstrip('`'))
-            get_logger().info(f"Successfully parsed AI prediction after removing {i} lines")
+            get_logger().info(f"Successfully parsed AI prediction after extracting yaml snippet")
-            break
+            return data
         except:
             pass
-    
+
-    # thrid fallback - try to remove leading and trailing curly brackets
+     # third fallback - try to remove leading and trailing curly brackets
-    response_text_copy = response_text.strip().rstrip().removeprefix('{').removesuffix('}')
+    response_text_copy = response_text.strip().rstrip().removeprefix('{').removesuffix('}').rstrip(':\n')
     try:
-        data = yaml.safe_load(response_text_copy,)
+        data = yaml.safe_load(response_text_copy)
         get_logger().info(f"Successfully parsed AI prediction after removing curly brackets")
         return data
     except:
         pass
 
+    # fourth fallback - try to remove last lines
+    data = {}
+    for i in range(1, len(response_text_lines)):
+        response_text_lines_tmp = '\n'.join(response_text_lines[:-i])
+        try:
+            data = yaml.safe_load(response_text_lines_tmp)
+            get_logger().info(f"Successfully parsed AI prediction after removing {i} lines")
+            return data
+        except:
+            pass
 
-def set_custom_labels(variables):
+
+def set_custom_labels(variables, git_provider=None):
     if not get_settings().config.enable_custom_labels:
         return
 
@@ -348,15 +466,18 @@ def set_custom_labels(variables):
         labels_list = f"      - {labels_list}" if labels_list else ""
         variables["custom_labels"] = labels_list
         return
-    #final_labels = ""
+
-    #for k, v in labels.items():
+    # Set custom labels
-    #    final_labels += f"      - {k} ({v['description']})\n"
-    #variables["custom_labels"] = final_labels
-    #variables["custom_labels_examples"] = f"      - {list(labels.keys())[0]}"
     variables["custom_labels_class"] = "class Label(str, Enum):"
+    counter = 0
+    labels_minimal_to_labels_dict = {}
     for k, v in labels.items():
-        description = v['description'].strip('\n').replace('\n', '\\n')
+        description = "'" + v['description'].strip('\n').replace('\n', '\\n') + "'"
-        variables["custom_labels_class"] += f"\n    {k.lower().replace(' ', '_')} = '{k}' # {description}"
+        # variables["custom_labels_class"] += f"\n    {k.lower().replace(' ', '_')} = '{k}' # {description}"
+        variables["custom_labels_class"] += f"\n    {k.lower().replace(' ', '_')} = {description}"
+        labels_minimal_to_labels_dict[k.lower().replace(' ', '_')] = k
+        counter += 1
+    variables["labels_minimal_to_labels_dict"] = labels_minimal_to_labels_dict
 
 def get_user_labels(current_labels: List[str] = None):
     """
@@ -374,7 +495,7 @@ def get_user_labels(current_labels: List[str] = None):
                     continue
             user_labels.append(label)
         if user_labels:
-            get_logger().info(f"Keeping user labels: {user_labels}")
+            get_logger().debug(f"Keeping user labels: {user_labels}")
     except Exception as e:
         get_logger().exception(f"Failed to get user labels: {e}")
         return current_labels
@@ -423,3 +544,84 @@ def clip_tokens(text: str, max_tokens: int, add_three_dots=True) -> str:
     except Exception as e:
         get_logger().warning(f"Failed to clip tokens: {e}")
         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)
+
+
+def find_line_number_of_relevant_line_in_file(diff_files: List[FilePatchInfo],
+                                              relevant_file: str,
+                                              relevant_line_in_file: str,
+                                              absolute_position: int = None) -> Tuple[int, int]:
+    position = -1
+    if absolute_position is None:
+        absolute_position = -1
+    re_hunk_header = re.compile(
+        r"^@@ -(\d+)(?:,(\d+))? \+(\d+)(?:,(\d+))? @@[ ]?(.*)")
+
+    for file in diff_files:
+        if file.filename and (file.filename.strip() == relevant_file):
+            patch = file.patch
+            patch_lines = patch.splitlines()
+            delta = 0
+            start1, size1, start2, size2 = 0, 0, 0, 0
+            if absolute_position != -1: # matching absolute to relative
+                for i, line in enumerate(patch_lines):
+                    # new hunk
+                    if line.startswith('@@'):
+                        delta = 0
+                        match = re_hunk_header.match(line)
+                        start1, size1, start2, size2 = map(int, match.groups()[:4])
+                    elif not line.startswith('-'):
+                        delta += 1
+
+                    #
+                    absolute_position_curr = start2 + delta - 1
+
+                    if absolute_position_curr == absolute_position:
+                        position = i
+                        break
+            else:
+                # try to find the line in the patch using difflib, with some margin of error
+                matches_difflib: list[str | Any] = difflib.get_close_matches(relevant_line_in_file,
+                                                                             patch_lines, n=3, cutoff=0.93)
+                if len(matches_difflib) == 1 and matches_difflib[0].startswith('+'):
+                    relevant_line_in_file = matches_difflib[0]
+
+
+                for i, line in enumerate(patch_lines):
+                    if line.startswith('@@'):
+                        delta = 0
+                        match = re_hunk_header.match(line)
+                        start1, size1, start2, size2 = map(int, match.groups()[:4])
+                    elif not line.startswith('-'):
+                        delta += 1
+
+                    if relevant_line_in_file in line and line[0] != '-':
+                        position = i
+                        absolute_position = start2 + delta - 1
+                        break
+
+                if position == -1 and relevant_line_in_file[0] == '+':
+                    no_plus_line = relevant_line_in_file[1:].lstrip()
+                    for i, line in enumerate(patch_lines):
+                        if line.startswith('@@'):
+                            delta = 0
+                            match = re_hunk_header.match(line)
+                            start1, size1, start2, size2 = map(int, match.groups()[:4])
+                        elif not line.startswith('-'):
+                            delta += 1
+
+                        if no_plus_line in line and line[0] != '-':
+                            # The model might add a '+' to the beginning of the relevant_line_in_file even if originally
+                            # it's a context line
+                            position = i
+                            absolute_position = start2 + delta - 1
+                            break
+    return position, absolute_position

pr_agent/cli.py

@@ -6,7 +6,8 @@ from pr_agent.agent.pr_agent import PRAgent, commands
 from pr_agent.config_loader import get_settings
 from pr_agent.log import setup_logger
 
-setup_logger()
+log_level = os.environ.get("LOG_LEVEL", "INFO")
+setup_logger(log_level)
 
 
 

pr_agent/config_loader.py

@@ -18,6 +18,7 @@ global_settings = Dynaconf(
         "settings/language_extensions.toml",
         "settings/pr_reviewer_prompts.toml",
         "settings/pr_questions_prompts.toml",
+        "settings/pr_line_questions_prompts.toml",
         "settings/pr_description_prompts.toml",
         "settings/pr_code_suggestions_prompts.toml",
         "settings/pr_sort_code_suggestions_prompts.toml",

pr_agent/git_providers/azuredevops_provider.py

@@ -1,32 +1,48 @@
-import json
+import os
 from typing import Optional, Tuple
 from urllib.parse import urlparse
 
-import os
-
 from ..log import get_logger
+from ..algo.language_handler import is_valid_file
+from ..algo.utils import clip_tokens, find_line_number_of_relevant_line_in_file, load_large_diff
+from ..config_loader import get_settings
+from .git_provider import GitProvider
+from pr_agent.algo.types import EDIT_TYPE, FilePatchInfo
 
 AZURE_DEVOPS_AVAILABLE = True
+ADO_APP_CLIENT_DEFAULT_ID = "499b84ac-1321-427f-aa17-267ca6975798/.default"
+MAX_PR_DESCRIPTION_AZURE_LENGTH = 4000-1
+
 try:
+    # noinspection PyUnresolvedReferences
     from msrest.authentication import BasicAuthentication
+    # noinspection PyUnresolvedReferences
     from azure.devops.connection import Connection
-    from azure.devops.v7_1.git.models import Comment, CommentThread, GitVersionDescriptor, GitPullRequest
+    # noinspection PyUnresolvedReferences
+    from azure.identity import DefaultAzureCredential
+    # noinspection PyUnresolvedReferences
+    from azure.devops.v7_1.git.models import (
+        Comment,
+        CommentThread,
+        GitVersionDescriptor,
+        GitPullRequest,
+    )
 except ImportError:
     AZURE_DEVOPS_AVAILABLE = False
 
-from ..config_loader import get_settings
-from ..algo.utils import load_large_diff, clip_tokens
-from ..algo.language_handler import is_valid_file
-from .git_provider import EDIT_TYPE, FilePatchInfo
 
+class AzureDevopsProvider(GitProvider):
 
-class AzureDevopsProvider:
+    def __init__(
-    def __init__(self, pr_url: Optional[str] = None, incremental: Optional[bool] = False):
+            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.")
+            raise ImportError(
+                "Azure DevOps provider is not available. Please install the required dependencies."
+            )
 
         self.azure_devops_client = self._get_azure_devops_client()
-
+        self.diff_files = None
         self.workspace_slug = None
         self.repo_slug = None
         self.repo = None
@@ -37,9 +53,134 @@ class AzureDevopsProvider:
         if pr_url:
             self.set_pr(pr_url)
 
+    def publish_code_suggestions(self, code_suggestions: list) -> bool:
+        """
+        Publishes code suggestions as comments on the PR.
+        """
+        post_parameters_list = []
+        for suggestion in code_suggestions:
+            body = suggestion['body']
+            relevant_file = suggestion['relevant_file']
+            relevant_lines_start = suggestion['relevant_lines_start']
+            relevant_lines_end = suggestion['relevant_lines_end']
+
+            if not relevant_lines_start or relevant_lines_start == -1:
+                if get_settings().config.verbosity_level >= 2:
+                    get_logger().exception(
+                        f"Failed to publish code suggestion, relevant_lines_start is {relevant_lines_start}")
+                continue
+
+            if relevant_lines_end < relevant_lines_start:
+                if get_settings().config.verbosity_level >= 2:
+                    get_logger().exception(f"Failed to publish code suggestion, "
+                                           f"relevant_lines_end is {relevant_lines_end} and "
+                                           f"relevant_lines_start is {relevant_lines_start}")
+                continue
+
+            if relevant_lines_end > relevant_lines_start:
+                post_parameters = {
+                    "body": body,
+                    "path": relevant_file,
+                    "line": relevant_lines_end,
+                    "start_line": relevant_lines_start,
+                    "start_side": "RIGHT",
+                }
+            else:  # API is different for single line comments
+                post_parameters = {
+                    "body": body,
+                    "path": relevant_file,
+                    "line": relevant_lines_start,
+                    "side": "RIGHT",
+                }
+            post_parameters_list.append(post_parameters)
+
+        try:
+            for post_parameters in post_parameters_list:
+                comment = Comment(content=post_parameters["body"], comment_type=1)
+                thread = CommentThread(comments=[comment],
+                                       thread_context={
+                                           "filePath": post_parameters["path"],
+                                           "rightFileStart": {
+                                               "line": post_parameters["start_line"],
+                                               "offset": 1,
+                                           },
+                                           "rightFileEnd": {
+                                               "line": post_parameters["line"],
+                                               "offset": 1,
+                                           },
+                                       })
+                self.azure_devops_client.create_thread(
+                    comment_thread=thread,
+                    project=self.workspace_slug,
+                    repository_id=self.repo_slug,
+                    pull_request_id=self.pr_num
+                )
+                if get_settings().config.verbosity_level >= 2:
+                    get_logger().info(
+                        f"Published code suggestion on {self.pr_num} at {post_parameters['path']}"
+                    )
+            return True
+        except Exception as e:
+            if get_settings().config.verbosity_level >= 2:
+                get_logger().error(f"Failed to publish code suggestion, error: {e}")
+            return False
+
+    def get_pr_description_full(self) -> str:
+        return self.pr.description
+
+    def edit_comment(self, comment, body: str):
+        try:
+            self.azure_devops_client.update_comment(
+                repository_id=self.repo_slug,
+                pull_request_id=self.pr_num,
+                thread_id=comment["thread_id"],
+                comment_id=comment["comment_id"],
+                comment=Comment(content=body),
+                project=self.workspace_slug,
+            )
+        except Exception as e:
+            get_logger().exception(f"Failed to edit comment, error: {e}")
+
+    def remove_comment(self, comment):
+        try:
+            self.azure_devops_client.delete_comment(
+                repository_id=self.repo_slug,
+                pull_request_id=self.pr_num,
+                thread_id=comment["thread_id"],
+                comment_id=comment["comment_id"],
+                project=self.workspace_slug,
+            )
+        except Exception as e:
+            get_logger().exception(f"Failed to remove comment, error: {e}")
+
+    def publish_labels(self, pr_types):
+        try:
+            for pr_type in pr_types:
+                self.azure_devops_client.create_pull_request_label(
+                    label={"name": pr_type},
+                    project=self.workspace_slug,
+                    repository_id=self.repo_slug,
+                    pull_request_id=self.pr_num,
+                )
+        except Exception as e:
+            get_logger().exception(f"Failed to publish labels, error: {e}")
+
+    def get_pr_labels(self):
+        try:
+            labels = self.azure_devops_client.get_pull_request_labels(
+                project=self.workspace_slug,
+                repository_id=self.repo_slug,
+                pull_request_id=self.pr_num,
+            )
+            return [label.name for label in labels]
+        except Exception as e:
+            get_logger().exception(f"Failed to get labels, error: {e}")
+            return []
+
     def is_supported(self, capability: str) -> bool:
-        if capability in ['get_issue_comments', 'create_inline_comment', 'publish_inline_comments', 'get_labels',
+        if capability in [
-                          'remove_initial_comment', 'gfm_markdown']:
+            "get_issue_comments",
+        ]:
             return False
         return True
 
@@ -49,49 +190,67 @@ class AzureDevopsProvider:
 
     def get_repo_settings(self):
         try:
-            contents = self.azure_devops_client.get_item_content(repository_id=self.repo_slug,
+            contents = self.azure_devops_client.get_item_content(
-                                                                 project=self.workspace_slug, download=False,
+                repository_id=self.repo_slug,
-                                                                 include_content_metadata=False, include_content=True,
+                project=self.workspace_slug,
-                                                                 path=".pr_agent.toml")
+                download=False,
-            return contents
+                include_content_metadata=False,
+                include_content=True,
+                path=".pr_agent.toml",
+            )
+            return list(contents)[0]
         except Exception as e:
-            get_logger().exception("get repo settings error")
+            if get_settings().config.verbosity_level >= 2:
+                get_logger().error(f"Failed to get repo settings, error: {e}")
             return ""
 
     def get_files(self):
         files = []
-        for i in self.azure_devops_client.get_pull_request_commits(project=self.workspace_slug,
+        for i in self.azure_devops_client.get_pull_request_commits(
-                                                                   repository_id=self.repo_slug,
+                project=self.workspace_slug,
-                                                                   pull_request_id=self.pr_num):
+                repository_id=self.repo_slug,
-
+                pull_request_id=self.pr_num,
-            changes_obj = self.azure_devops_client.get_changes(project=self.workspace_slug,
+        ):
-                                                               repository_id=self.repo_slug, commit_id=i.commit_id)
+            changes_obj = self.azure_devops_client.get_changes(
+                project=self.workspace_slug,
+                repository_id=self.repo_slug,
+                commit_id=i.commit_id,
+            )
 
             for c in changes_obj.changes:
-                files.append(c['item']['path'])
+                files.append(c["item"]["path"])
         return list(set(files))
 
     def get_diff_files(self) -> list[FilePatchInfo]:
         try:
+
+            if self.diff_files:
+                return self.diff_files
+
             base_sha = self.pr.last_merge_target_commit
             head_sha = self.pr.last_merge_source_commit
 
-            commits = self.azure_devops_client.get_pull_request_commits(project=self.workspace_slug,
+            commits = self.azure_devops_client.get_pull_request_commits(
-                                                                        repository_id=self.repo_slug,
+                project=self.workspace_slug,
-                                                                        pull_request_id=self.pr_num)
+                repository_id=self.repo_slug,
+                pull_request_id=self.pr_num,
+            )
 
             diff_files = []
             diffs = []
             diff_types = {}
 
             for c in commits:
-                changes_obj = self.azure_devops_client.get_changes(project=self.workspace_slug,
+                changes_obj = self.azure_devops_client.get_changes(
-                                                                   repository_id=self.repo_slug, commit_id=c.commit_id)
+                    project=self.workspace_slug,
+                    repository_id=self.repo_slug,
+                    commit_id=c.commit_id,
+                )
                 for i in changes_obj.changes:
-                    if(i['item']['gitObjectType'] == 'tree'):
+                    if i["item"]["gitObjectType"] == "tree":
                         continue
-                    diffs.append(i['item']['path'])
+                    diffs.append(i["item"]["path"])
-                    diff_types[i['item']['path']] = i['changeType']
+                    diff_types[i["item"]["path"]] = i["changeType"]
 
             diffs = list(set(diffs))
 
@@ -99,118 +258,217 @@ class AzureDevopsProvider:
                 if not is_valid_file(file):
                     continue
 
-                version = GitVersionDescriptor(version=head_sha.commit_id, version_type='commit')
+                version = GitVersionDescriptor(
+                    version=head_sha.commit_id, version_type="commit"
+                )
                 try:
-                    new_file_content_str = self.azure_devops_client.get_item(repository_id=self.repo_slug,
+                    new_file_content_str = self.azure_devops_client.get_item(
-                                                                            path=file,
+                        repository_id=self.repo_slug,
-                                                                            project=self.workspace_slug,
+                        path=file,
-                                                                            version_descriptor=version,
+                        project=self.workspace_slug,
-                                                                            download=False,
+                        version_descriptor=version,
-                                                                            include_content=True)
+                        download=False,
+                        include_content=True,
+                    )
 
                     new_file_content_str = new_file_content_str.content
                 except Exception as error:
-                    get_logger().error("Failed to retrieve new file content of %s at version %s. Error: %s", file, version, str(error))
+                    get_logger().error(
+                        "Failed to retrieve new file content of %s at version %s. Error: %s",
+                        file,
+                        version,
+                        str(error),
+                    )
                     new_file_content_str = ""
 
                 edit_type = EDIT_TYPE.MODIFIED
-                if diff_types[file] == 'add':
+                if diff_types[file] == "add":
                     edit_type = EDIT_TYPE.ADDED
-                elif diff_types[file] == 'delete':
+                elif diff_types[file] == "delete":
                     edit_type = EDIT_TYPE.DELETED
-                elif diff_types[file] == 'rename':
+                elif diff_types[file] == "rename":
                     edit_type = EDIT_TYPE.RENAMED
 
-                version = GitVersionDescriptor(version=base_sha.commit_id, version_type='commit')
+                version = GitVersionDescriptor(
+                    version=base_sha.commit_id, version_type="commit"
+                )
                 try:
-                    original_file_content_str = self.azure_devops_client.get_item(repository_id=self.repo_slug,
+                    original_file_content_str = self.azure_devops_client.get_item(
-                                                                              path=file,
+                        repository_id=self.repo_slug,
-                                                                              project=self.workspace_slug,
+                        path=file,
-                                                                              version_descriptor=version,
+                        project=self.workspace_slug,
-                                                                              download=False,
+                        version_descriptor=version,
-                                                                              include_content=True)
+                        download=False,
+                        include_content=True,
+                    )
                     original_file_content_str = original_file_content_str.content
                 except Exception as error:
-                    get_logger().error("Failed to retrieve original file content of %s at version %s. Error: %s", file, version, str(error))
+                    get_logger().error(
+                        "Failed to retrieve original file content of %s at version %s. Error: %s",
+                        file,
+                        version,
+                        str(error),
+                    )
                     original_file_content_str = ""
 
-                patch = load_large_diff(file, new_file_content_str, original_file_content_str)
+                patch = load_large_diff(
-
+                    file, new_file_content_str, original_file_content_str
-                diff_files.append(FilePatchInfo(original_file_content_str, new_file_content_str,
+                )
-                                                patch=patch,
-                                                filename=file,
-                                                edit_type=edit_type))
 
+                diff_files.append(
+                    FilePatchInfo(
+                        original_file_content_str,
+                        new_file_content_str,
+                        patch=patch,
+                        filename=file,
+                        edit_type=edit_type,
+                    )
+                )
             self.diff_files = diff_files
             return diff_files
         except Exception as e:
             print(f"Error: {str(e)}")
             return []
 
-    def publish_comment(self, pr_comment: str, is_temporary: bool = False):
+    def publish_comment(self, pr_comment: str, is_temporary: bool = False, thread_context=None):
         comment = Comment(content=pr_comment)
-        thread = CommentThread(comments=[comment])
+        thread = CommentThread(comments=[comment], thread_context=thread_context, status=1)
-        thread_response = self.azure_devops_client.create_thread(comment_thread=thread, project=self.workspace_slug,
+        thread_response = self.azure_devops_client.create_thread(
-                                                                 repository_id=self.repo_slug,
+            comment_thread=thread,
-                                                                 pull_request_id=self.pr_num)
+            project=self.workspace_slug,
+            repository_id=self.repo_slug,
+            pull_request_id=self.pr_num,
+        )
+        response = {"thread_id": thread_response.id, "comment_id": thread_response.comments[0].id}
         if is_temporary:
-            self.temp_comments.append({'thread_id': thread_response.id, 'comment_id': comment.id})
+            self.temp_comments.append(response)
+        return response
 
     def publish_description(self, pr_title: str, pr_body: str):
+        if len(pr_body) > MAX_PR_DESCRIPTION_AZURE_LENGTH:
+
+            usage_guide_text='<details> <summary><strong>✨ Describe tool usage guide:</strong></summary><hr>'
+            ind = pr_body.find(usage_guide_text)
+            if ind != -1:
+                pr_body = pr_body[:ind]
+
+            if len(pr_body) > MAX_PR_DESCRIPTION_AZURE_LENGTH:
+                changes_walkthrough_text = '## **Changes walkthrough**'
+                ind = pr_body.find(changes_walkthrough_text)
+                if ind != -1:
+                    pr_body = pr_body[:ind]
+
+            if len(pr_body) > MAX_PR_DESCRIPTION_AZURE_LENGTH:
+                trunction_message = " ... (description truncated due to length limit)"
+                pr_body = pr_body[:MAX_PR_DESCRIPTION_AZURE_LENGTH - len(trunction_message)] + trunction_message
+                get_logger().warning("PR description was truncated due to length limit")
         try:
             updated_pr = GitPullRequest()
             updated_pr.title = pr_title
             updated_pr.description = pr_body
-            self.azure_devops_client.update_pull_request(project=self.workspace_slug,
+            self.azure_devops_client.update_pull_request(
-                                                         repository_id=self.repo_slug,
+                project=self.workspace_slug,
-                                                         pull_request_id=self.pr_num,
+                repository_id=self.repo_slug,
-                                                         git_pull_request_to_update=updated_pr)
+                pull_request_id=self.pr_num,
+                git_pull_request_to_update=updated_pr,
+            )
         except Exception as e:
-            get_logger().exception(f"Could not update pull request {self.pr_num} description: {e}")
+            get_logger().exception(
+                f"Could not update pull request {self.pr_num} description: {e}"
+            )
 
     def remove_initial_comment(self):
-        return ""  # not implemented yet
+        try:
+            for comment in self.temp_comments:
+                self.remove_comment(comment)
+        except Exception as e:
+            get_logger().exception(f"Failed to remove temp comments, error: {e}")
 
     def publish_inline_comment(self, body: str, relevant_file: str, relevant_line_in_file: str):
-        raise NotImplementedError("Azure DevOps provider does not support publishing inline comment yet")
+        self.publish_inline_comments([self.create_inline_comment(body, relevant_file, relevant_line_in_file)])
 
-    def create_inline_comment(self, body: str, relevant_file: str, relevant_line_in_file: str):
-        raise NotImplementedError("Azure DevOps provider does not support creating inline comments yet")
 
-    def publish_inline_comments(self, comments: list[dict]):
+    def create_inline_comment(self, body: str, relevant_file: str, relevant_line_in_file: str,
-        raise NotImplementedError("Azure DevOps provider does not support publishing inline comments yet")
+                              absolute_position: int = None):
+        position, absolute_position = find_line_number_of_relevant_line_in_file(self.get_diff_files(),
+                                                                                relevant_file.strip('`'),
+                                                                                relevant_line_in_file,
+                                                                                absolute_position)
+        if position == -1:
+            if get_settings().config.verbosity_level >= 2:
+                get_logger().info(f"Could not find position for {relevant_file} {relevant_line_in_file}")
+            subject_type = "FILE"
+        else:
+            subject_type = "LINE"
+        path = relevant_file.strip()
+        return dict(body=body, path=path, position=position, absolute_position=absolute_position) if subject_type == "LINE" else {}
+
+    def publish_inline_comments(self, comments: list[dict], disable_fallback: bool = False):
+            overall_sucess = True
+            for comment in comments:
+                try:
+                    self.publish_comment(comment["body"],
+                                        thread_context={
+                                            "filePath": comment["path"],
+                                            "rightFileStart": {
+                                                "line": comment["absolute_position"],
+                                                "offset": comment["position"],
+                                            },
+                                            "rightFileEnd": {
+                                                "line": comment["absolute_position"],
+                                                "offset": comment["position"],
+                                            },
+                                        })
+                    if get_settings().config.verbosity_level >= 2:
+                        get_logger().info(
+                            f"Published code suggestion on {self.pr_num} at {comment['path']}"
+                        )
+                except Exception as e:
+                    if get_settings().config.verbosity_level >= 2:
+                        get_logger().error(f"Failed to publish code suggestion, error: {e}")
+                    overall_sucess = False
+            return overall_sucess
 
     def get_title(self):
         return self.pr.title
 
     def get_languages(self):
         languages = []
-        files = self.azure_devops_client.get_items(project=self.workspace_slug, repository_id=self.repo_slug,
+        files = self.azure_devops_client.get_items(
-                                                   recursion_level="Full", include_content_metadata=True,
+            project=self.workspace_slug,
-                                                   include_links=False, download=False)
+            repository_id=self.repo_slug,
+            recursion_level="Full",
+            include_content_metadata=True,
+            include_links=False,
+            download=False,
+        )
         for f in files:
-            if f.git_object_type == 'blob':
+            if f.git_object_type == "blob":
                 file_name, file_extension = os.path.splitext(f.path)
                 languages.append(file_extension[1:])
 
         extension_counts = {}
         for ext in languages:
-            if ext != '':
+            if ext != "":
                 extension_counts[ext] = extension_counts.get(ext, 0) + 1
 
         total_extensions = sum(extension_counts.values())
 
-        extension_percentages = {ext: (count / total_extensions) * 100 for ext, count in extension_counts.items()}
+        extension_percentages = {
+            ext: (count / total_extensions) * 100
+            for ext, count in extension_counts.items()
+        }
 
         return extension_percentages
 
     def get_pr_branch(self):
-        pr_info = self.azure_devops_client.get_pull_request_by_id(project=self.workspace_slug,
+        pr_info = self.azure_devops_client.get_pull_request_by_id(
-                                                                  pull_request_id=self.pr_num)
+            project=self.workspace_slug, pull_request_id=self.pr_num
-        source_branch = pr_info.source_ref_name.split('/')[-1]
+        )
+        source_branch = pr_info.source_ref_name.split("/")[-1]
         return source_branch
 
-    def get_pr_description(self):
+    def get_pr_description(self, *, full: bool = True) -> str:
         max_tokens = get_settings().get("CONFIG.MAX_DESCRIPTION_TOKENS", None)
         if max_tokens:
             return clip_tokens(self.pr.description, max_tokens)
@@ -220,25 +478,26 @@ class AzureDevopsProvider:
         return 0
 
     def get_issue_comments(self):
-        raise NotImplementedError("Azure DevOps provider does not support issue comments yet")
+        raise NotImplementedError(
+            "Azure DevOps provider does not support issue comments yet"
+        )
 
-    def add_eyes_reaction(self, issue_comment_id: int) -> Optional[int]:
+    def add_eyes_reaction(self, issue_comment_id: int, disable_eyes: bool = False) -> Optional[int]:
         return True
 
     def remove_reaction(self, issue_comment_id: int, reaction_id: int) -> bool:
         return True
 
-    def get_issue_comments(self):
-        raise NotImplementedError("Azure DevOps provider does not support issue comments yet")
-
     @staticmethod
-    def _parse_pr_url(pr_url: str) -> Tuple[str, int]:
+    def _parse_pr_url(pr_url: str) -> Tuple[str, str, int]:
         parsed_url = urlparse(pr_url)
 
-        path_parts = parsed_url.path.strip('/').split('/')
+        path_parts = parsed_url.path.strip("/").split("/")
 
-        if len(path_parts) < 6 or path_parts[4] != 'pullrequest':
+        if len(path_parts) < 6 or path_parts[4] != "pullrequest":
-            raise ValueError("The provided URL does not appear to be a Azure DevOps PR URL")
+            raise ValueError(
+                "The provided URL does not appear to be a Azure DevOps PR URL"
+            )
 
         workspace_slug = path_parts[1]
         repo_slug = path_parts[3]
@@ -249,15 +508,32 @@ class AzureDevopsProvider:
 
         return workspace_slug, repo_slug, pr_number
 
-    def _get_azure_devops_client(self):
+    @staticmethod
-        try:
+    def _get_azure_devops_client():
-            pat = get_settings().azure_devops.pat
+        org = get_settings().azure_devops.get("org", None)
-            org = get_settings().azure_devops.org
+        pat = get_settings().azure_devops.get("pat", None)
-        except AttributeError as e:
-            raise ValueError(
-                "Azure DevOps PAT token is required ") from e
 
-        credentials = BasicAuthentication('', pat)
+        if not org:
+            raise ValueError("Azure DevOps organization is required")
+
+        if pat:
+            auth_token = pat
+        else:
+            try:
+                # try to use azure default credentials
+                # see https://learn.microsoft.com/en-us/python/api/overview/azure/identity-readme?view=azure-python
+                # for usage and env var configuration of user-assigned managed identity, local machine auth etc.
+                get_logger().info("No PAT found in settings, trying to use Azure Default Credentials.")
+                credentials = DefaultAzureCredential()
+                accessToken = credentials.get_token(ADO_APP_CLIENT_DEFAULT_ID)
+                auth_token = accessToken.token
+            except Exception as e:
+                get_logger().error(f"No PAT found in settings, and Azure Default Authentication failed, error: {e}")
+                raise
+
+        credentials = BasicAuthentication("", auth_token)
+
+        credentials = BasicAuthentication("", auth_token)
         azure_devops_connection = Connection(base_url=org, creds=credentials)
         azure_devops_client = azure_devops_connection.clients.get_git_client()
 
@@ -265,13 +541,26 @@ class AzureDevopsProvider:
 
     def _get_repo(self):
         if self.repo is None:
-            self.repo = self.azure_devops_client.get_repository(project=self.workspace_slug,
+            self.repo = self.azure_devops_client.get_repository(
-                                                                repository_id=self.repo_slug)
+                project=self.workspace_slug, repository_id=self.repo_slug
+            )
         return self.repo
 
     def _get_pr(self):
-        self.pr = self.azure_devops_client.get_pull_request_by_id(pull_request_id=self.pr_num, project=self.workspace_slug)
+        self.pr = self.azure_devops_client.get_pull_request_by_id(
+            pull_request_id=self.pr_num, project=self.workspace_slug
+        )
         return self.pr
 
     def get_commit_messages(self):
         return ""  # not implemented yet
+
+    def get_pr_id(self):
+        try:
+            pr_id = f"{self.workspace_slug}/{self.repo_slug}/{self.pr_num}"
+            return pr_id
+        except Exception as e:
+            if get_settings().config.verbosity_level >= 2:
+                get_logger().error(f"Failed to get pr id, error: {e}")
+            return ""
+

pr_agent/git_providers/bitbucket_provider.py

@@ -6,10 +6,11 @@ import requests
 from atlassian.bitbucket import Cloud
 from starlette_context import context
 
-from ..algo.pr_processing import find_line_number_of_relevant_line_in_file
+from pr_agent.algo.types import FilePatchInfo, EDIT_TYPE
+from ..algo.utils import find_line_number_of_relevant_line_in_file
 from ..config_loader import get_settings
 from ..log import get_logger
-from .git_provider import FilePatchInfo, GitProvider, EDIT_TYPE
+from .git_provider import GitProvider
 
 
 class BitbucketProvider(GitProvider):
@@ -159,7 +160,11 @@ class BitbucketProvider(GitProvider):
     def get_comment_url(self, comment):
         return comment.data['links']['html']['href']
 
-    def publish_persistent_comment(self, pr_comment: str, initial_header: str, update_header: bool = True):
+    def publish_persistent_comment(self, pr_comment: str,
+                                   initial_header: str,
+                                   update_header: bool = True,
+                                   name='review',
+                                   final_update_message=True):
         try:
             for comment in self.pr.comments():
                 body = comment.raw
@@ -167,15 +172,16 @@ class BitbucketProvider(GitProvider):
                     latest_commit_url = self.get_latest_commit_url()
                     comment_url = self.get_comment_url(comment)
                     if update_header:
-                        updated_header = f"{initial_header}\n\n### (review updated until commit {latest_commit_url})\n"
+                        updated_header = f"{initial_header}\n\n### ({name.capitalize()} updated until commit {latest_commit_url})\n"
                         pr_comment_updated = pr_comment.replace(initial_header, updated_header)
                     else:
                         pr_comment_updated = pr_comment
-                    get_logger().info(f"Persistent mode- updating comment {comment_url} to latest review message")
+                    get_logger().info(f"Persistent mode - updating comment {comment_url} to latest {name} message")
                     d = {"content": {"raw": pr_comment_updated}}
                     response = comment._update_data(comment.put(None, data=d))
-                    self.publish_comment(
+                    if final_update_message:
-                        f"**[Persistent review]({comment_url})** updated to latest commit {latest_commit_url}")
+                        self.publish_comment(
+                            f"**[Persistent {name}]({comment_url})** updated to latest commit {latest_commit_url}")
                     return
         except Exception as e:
             get_logger().exception(f"Failed to update persistent review, error: {e}")
@@ -186,6 +192,13 @@ class BitbucketProvider(GitProvider):
         comment = self.pr.comment(pr_comment)
         if is_temporary:
             self.temp_comments.append(comment["id"])
+        return comment
+
+    def edit_comment(self, comment, body: str):
+        try:
+            comment.update(body)
+        except Exception as e:
+            get_logger().exception(f"Failed to update comment, error: {e}")
 
     def remove_initial_comment(self):
         try:
@@ -201,8 +214,10 @@ class BitbucketProvider(GitProvider):
             get_logger().exception(f"Failed to remove comment, error: {e}")
 
     # funtion to create_inline_comment
-    def create_inline_comment(self, body: str, relevant_file: str, relevant_line_in_file: str):
+    def create_inline_comment(self, body: str, relevant_file: str, relevant_line_in_file: str, absolute_position: int = None):
-        position, absolute_position = find_line_number_of_relevant_line_in_file(self.get_diff_files(), relevant_file.strip('`'), relevant_line_in_file)
+        position, absolute_position = find_line_number_of_relevant_line_in_file(self.get_diff_files(),
+                                                                            relevant_file.strip('`'),
+                                                                            relevant_line_in_file, absolute_position)
         if position == -1:
             if get_settings().config.verbosity_level >= 2:
                 get_logger().info(f"Could not find position for {relevant_file} {relevant_line_in_file}")
@@ -237,8 +252,8 @@ class BitbucketProvider(GitProvider):
 
     def generate_link_to_relevant_line_number(self, suggestion) -> str:
         try:
-            relevant_file = suggestion['relevant file'].strip('`').strip("'")
+            relevant_file = suggestion['relevant_file'].strip('`').strip("'").rstrip()
-            relevant_line_str = suggestion['relevant line']
+            relevant_line_str = suggestion['relevant_line'].rstrip()
             if not relevant_line_str:
                 return ""
 
@@ -288,7 +303,7 @@ class BitbucketProvider(GitProvider):
             "Bitbucket provider does not support issue comments yet"
         )
 
-    def add_eyes_reaction(self, issue_comment_id: int) -> Optional[int]:
+    def add_eyes_reaction(self, issue_comment_id: int, disable_eyes: bool = False) -> Optional[int]:
         return True
 
     def remove_reaction(self, issue_comment_id: int, reaction_id: int) -> bool:
@@ -327,6 +342,41 @@ class BitbucketProvider(GitProvider):
     def _get_pr(self):
         return self._get_repo().pullrequests.get(self.pr_num)
 
+    def get_pr_file_content(self, file_path: str, branch: str) -> str:
+        try:
+            if branch == self.pr.source_branch:
+                branch = self.pr.data["source"]["commit"]["hash"]
+            elif branch == self.pr.destination_branch:
+                branch = self.pr.data["destination"]["commit"]["hash"]
+            url = (f"https://api.bitbucket.org/2.0/repositories/{self.workspace_slug}/{self.repo_slug}/src/"
+                   f"{branch}/{file_path}")
+            response = requests.request("GET", url, headers=self.headers)
+            if response.status_code == 404:  # not found
+                return ""
+            contents = response.text
+            return contents
+        except Exception:
+            return ""
+
+
+    def create_or_update_pr_file(self, file_path: str, branch: str, contents="", message="") -> None:
+        url = (f"https://api.bitbucket.org/2.0/repositories/{self.workspace_slug}/{self.repo_slug}/src/")
+        if not message:
+            if contents:
+                message = f"Update {file_path}"
+            else:
+                message = f"Create {file_path}"
+        files={file_path: contents}
+        data={
+            "message": message,
+            "branch": branch
+        }
+        headers = {'Authorization':self.headers['Authorization']} if 'Authorization' in self.headers else {}
+        try:
+            requests.request("POST", url, headers=headers, data=data, files=files)
+        except Exception:
+            get_logger().exception(f"Failed to create empty file {file_path} in branch {branch}")
+
     def _get_pr_file_content(self, remote_link: str):
         return ""
 
@@ -354,5 +404,5 @@ class BitbucketProvider(GitProvider):
         pass
     
     # bitbucket does not support labels
-    def get_labels(self):
+    def get_pr_labels(self):
         pass

pr_agent/git_providers/bitbucket_server_provider.py

@@ -6,9 +6,9 @@ import requests
 from atlassian.bitbucket import Bitbucket
 from starlette_context import context
 
-from .git_provider import FilePatchInfo, GitProvider, EDIT_TYPE
+from .git_provider import GitProvider
-from ..algo.pr_processing import find_line_number_of_relevant_line_in_file
+from pr_agent.algo.types import FilePatchInfo
-from ..algo.utils import load_large_diff
+from ..algo.utils import load_large_diff, find_line_number_of_relevant_line_in_file
 from ..config_loader import get_settings
 from ..log import get_logger
 
@@ -210,11 +210,14 @@ class BitbucketServerProvider(GitProvider):
         pass
 
     # funtion to create_inline_comment
-    def create_inline_comment(self, body: str, relevant_file: str, relevant_line_in_file: str):
+    def create_inline_comment(self, body: str, relevant_file: str, relevant_line_in_file: str,
+                              absolute_position: int = None):
+
         position, absolute_position = find_line_number_of_relevant_line_in_file(
             self.get_diff_files(),
             relevant_file.strip('`'),
-            relevant_line_in_file
+            relevant_line_in_file,
+            absolute_position
         )
         if position == -1:
             if get_settings().config.verbosity_level >= 2:
@@ -243,8 +246,8 @@ class BitbucketServerProvider(GitProvider):
 
     def generate_link_to_relevant_line_number(self, suggestion) -> str:
         try:
-            relevant_file = suggestion['relevant file'].strip('`').strip("'")
+            relevant_file = suggestion['relevant_file'].strip('`').strip("'").rstrip()
-            relevant_line_str = suggestion['relevant line']
+            relevant_line_str = suggestion['relevant_line'].rstrip()
             if not relevant_line_str:
                 return ""
 
@@ -285,7 +288,7 @@ class BitbucketServerProvider(GitProvider):
             "Bitbucket provider does not support issue comments yet"
         )
 
-    def add_eyes_reaction(self, issue_comment_id: int) -> Optional[int]:
+    def add_eyes_reaction(self, issue_comment_id: int, disable_eyes: bool = False) -> Optional[int]:
         return True
 
     def remove_reaction(self, issue_comment_id: int, reaction_id: int) -> bool:
@@ -344,7 +347,7 @@ class BitbucketServerProvider(GitProvider):
         pass
     
     # bitbucket does not support labels
-    def get_labels(self):
+    def get_pr_labels(self):
         pass
 
     def _get_pr_comments_url(self):

pr_agent/git_providers/codecommit_provider.py

@@ -5,9 +5,9 @@ from typing import List, Optional, Tuple
 from urllib.parse import urlparse
 
 from pr_agent.git_providers.codecommit_client import CodeCommitClient
-
+from pr_agent.algo.types import EDIT_TYPE, FilePatchInfo
 from ..algo.utils import load_large_diff
-from .git_provider import EDIT_TYPE, FilePatchInfo, GitProvider
+from .git_provider import GitProvider
 from ..config_loader import get_settings
 from ..log import get_logger
 
@@ -216,7 +216,7 @@ class CodeCommitProvider(GitProvider):
     def publish_labels(self, labels):
         return [""]  # not implemented yet
 
-    def get_labels(self):
+    def get_pr_labels(self):
         return [""]  # not implemented yet
 
     def remove_initial_comment(self):
@@ -229,9 +229,6 @@ class CodeCommitProvider(GitProvider):
         # https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/codecommit/client/post_comment_for_compared_commit.html
         raise NotImplementedError("CodeCommit provider does not support publishing inline comments yet")
 
-    def create_inline_comment(self, body: str, relevant_file: str, relevant_line_in_file: str):
-        raise NotImplementedError("CodeCommit provider does not support creating inline comments yet")
-
     def publish_inline_comments(self, comments: list[dict]):
         raise NotImplementedError("CodeCommit provider does not support publishing inline comments yet")
 
@@ -300,7 +297,7 @@ class CodeCommitProvider(GitProvider):
         settings_filename = ".pr_agent.toml"
         return self.codecommit_client.get_file(self.repo_name, settings_filename, self.pr.source_commit, optional=True)
 
-    def add_eyes_reaction(self, issue_comment_id: int) -> Optional[int]:
+    def add_eyes_reaction(self, issue_comment_id: int, disable_eyes: bool = False) -> Optional[int]:
         get_logger().info("CodeCommit provider does not support eyes reaction yet")
         return True
 

pr_agent/git_providers/gerrit_provider.py

@@ -13,7 +13,8 @@ import urllib3.util
 from git import Repo
 
 from pr_agent.config_loader import get_settings
-from pr_agent.git_providers.git_provider import EDIT_TYPE, FilePatchInfo, GitProvider
+from pr_agent.git_providers.git_provider import GitProvider
+from pr_agent.algo.types import EDIT_TYPE, FilePatchInfo
 from pr_agent.git_providers.local_git_provider import PullRequestMimic
 from pr_agent.log import get_logger
 
@@ -207,11 +208,11 @@ class GerritProvider(GitProvider):
         Comment = namedtuple('Comment', ['body'])
         return Comments([Comment(c['message']) for c in reversed(comments)])
 
-    def get_labels(self):
+    def get_pr_labels(self):
         raise NotImplementedError(
             'Getting labels is not implemented for the gerrit provider')
 
-    def add_eyes_reaction(self, issue_comment_id: int):
+    def add_eyes_reaction(self, issue_comment_id: int, disable_eyes: bool = False):
         raise NotImplementedError(
             'Adding reactions is not implemented for the gerrit provider')
 
@@ -380,11 +381,6 @@ class GerritProvider(GitProvider):
             'Publishing inline comments is not implemented for the gerrit '
             'provider')
 
-    def create_inline_comment(self, body: str, relevant_file: str,
-                              relevant_line_in_file: str):
-        raise NotImplementedError(
-            'Creating inline comments is not implemented for the gerrit '
-            'provider')
 
     def publish_labels(self, labels):
         # Not applicable to the local git provider,

pr_agent/git_providers/git_provider.py

@@ -1,35 +1,13 @@
 from abc import ABC, abstractmethod
-from dataclasses import dataclass
 
 # enum EDIT_TYPE (ADDED, DELETED, MODIFIED, RENAMED)
-from enum import Enum
 from typing import Optional
 
 from pr_agent.config_loader import get_settings
+from pr_agent.algo.types import FilePatchInfo
 from pr_agent.log import get_logger
 
 
-class EDIT_TYPE(Enum):
-    ADDED = 1
-    DELETED = 2
-    MODIFIED = 3
-    RENAMED = 4
-    UNKNOWN = 5
-
-
-@dataclass
-class FilePatchInfo:
-    base_file: str
-    head_file: str
-    patch: str
-    filename: str
-    tokens: int = -1
-    edit_type: EDIT_TYPE = EDIT_TYPE.UNKNOWN
-    old_filename: str = None
-    num_plus_lines: int = -1
-    num_minus_lines: int = -1
-
-
 class GitProvider(ABC):
     @abstractmethod
     def is_supported(self, capability: str) -> bool:
@@ -63,6 +41,12 @@ class GitProvider(ABC):
     def get_pr_description_full(self) -> str:
         pass
 
+    def edit_comment(self, comment, body: str):
+        pass
+
+    def reply_to_comment_from_comment_id(self, comment_id: int, body: str):
+        pass
+
     def get_pr_description(self, *, full: bool = True) -> str:
         from pr_agent.config_loader import get_settings
         from pr_agent.algo.utils import clip_tokens
@@ -73,16 +57,57 @@ class GitProvider(ABC):
         return description
 
     def get_user_description(self) -> str:
+        if hasattr(self, 'user_description') and not (self.user_description is None):
+            return self.user_description
+
         description = (self.get_pr_description_full() or "").strip()
+        description_lowercase = description.lower()
+        get_logger().debug(f"Existing description", description=description_lowercase)
+
         # if the existing description wasn't generated by the pr-agent, just return it as-is
-        if not any(description.startswith(header) for header in ("## PR Type", "## PR Description")):
+        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
-        # if the existing description was generated by the pr-agent, but it doesn't contain the 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
-        if "## User Description:" not in description:
+        user_description_header = "## **user description**"
+        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 ""
+
         # otherwise, extract the original user description from the existing pr-agent description and return it
-        return description.split("## User Description:", 1)[1].strip()
+        # user_description_start_position = description_lowercase.find(user_description_header) + len(user_description_header)
+        # return description[user_description_start_position:].split("\n", 1)[-1].strip()
+
+        # the 'user description' is in the beginning. extract and return it
+        possible_headers = self._possible_headers()
+        start_position = description_lowercase.find(user_description_header) + len(user_description_header)
+        end_position = len(description)
+        for header in possible_headers: # try to clip at the next header
+            if header != user_description_header and header in description_lowercase:
+                end_position = min(end_position, description_lowercase.find(header))
+        if end_position != len(description) and end_position > start_position:
+            original_user_description = description[start_position:end_position].strip()
+            if original_user_description.endswith("___"):
+                original_user_description = original_user_description[:-3].strip()
+        else:
+            original_user_description = description.split("___")[0].strip()
+            if original_user_description.lower().startswith(user_description_header):
+                original_user_description = original_user_description[len(user_description_header):].strip()
+
+        get_logger().info(f"Extracted user description from existing description",
+                          description=original_user_description)
+        self.user_description = original_user_description
+        return original_user_description
+
+    def _possible_headers(self):
+        return ("## **user description**", "## **pr type**", "## **pr description**", "## **pr labels**", "## **type**", "## **description**",
+                "## **labels**", "### 🤖 generated by pr agent")
+
+    def _is_generated_by_pr_agent(self, description_lowercase: str) -> bool:
+        possible_headers = self._possible_headers()
+        return any(description_lowercase.startswith(header) for header in possible_headers)
 
     @abstractmethod
     def get_repo_settings(self):
@@ -99,16 +124,20 @@ class GitProvider(ABC):
     def publish_comment(self, pr_comment: str, is_temporary: bool = False):
         pass
 
-    def publish_persistent_comment(self, pr_comment: str, initial_header: str, update_header: bool):
+    def publish_persistent_comment(self, pr_comment: str,
+                                   initial_header: str,
+                                   update_header: bool = True,
+                                   name='review',
+                                   final_update_message=True):
         self.publish_comment(pr_comment)
 
     @abstractmethod
     def publish_inline_comment(self, body: str, relevant_file: str, relevant_line_in_file: str):
         pass
 
-    @abstractmethod
+    def create_inline_comment(self, body: str, relevant_file: str, relevant_line_in_file: str,
-    def create_inline_comment(self, body: str, relevant_file: str, relevant_line_in_file: str):
+                              absolute_position: int = None):
-        pass
+        raise NotImplementedError("This git provider does not support creating inline comments yet")
 
     @abstractmethod
     def publish_inline_comments(self, comments: list[dict]):
@@ -135,11 +164,14 @@ class GitProvider(ABC):
         pass
 
     @abstractmethod
-    def get_labels(self):
+    def get_pr_labels(self):
+        pass
+
+    def get_repo_labels(self):
         pass
 
     @abstractmethod
-    def add_eyes_reaction(self, issue_comment_id: int) -> Optional[int]:
+    def add_eyes_reaction(self, issue_comment_id: int, disable_eyes: bool = False) -> Optional[int]:
         pass
 
     @abstractmethod
@@ -151,9 +183,21 @@ class GitProvider(ABC):
     def get_commit_messages(self):
         pass
 
+    def get_pr_url(self) -> str:
+        if hasattr(self, 'pr_url'):
+            return self.pr_url
+        return ""
+
     def get_latest_commit_url(self) -> str:
         return ""
 
+    def auto_approve(self) -> bool:
+        return False
+
+    def calc_pr_statistics(self, pull_request_data: dict):
+        return {}
+
+
 def get_main_pr_language(languages, files) -> str:
     """
     Get the main language of the commit. Return an empty string if cannot determine.
@@ -222,7 +266,6 @@ def get_main_pr_language(languages, files) -> str:
 
     return main_language_str
 
-
 class IncrementalPR:
     def __init__(self, is_incremental: bool = False):
         self.is_incremental = is_incremental

pr_agent/git_providers/github_provider.py

@@ -1,3 +1,4 @@
+import time
 import hashlib
 from datetime import datetime
 from typing import Optional, Tuple
@@ -8,12 +9,12 @@ from retry import retry
 from starlette_context import context
 
 from ..algo.language_handler import is_valid_file
-from ..algo.pr_processing import find_line_number_of_relevant_line_in_file
+from ..algo.utils import load_large_diff, clip_tokens, find_line_number_of_relevant_line_in_file
-from ..algo.utils import load_large_diff, clip_tokens
 from ..config_loader import get_settings
 from ..log import get_logger
 from ..servers.utils import RateLimitExceeded
-from .git_provider import FilePatchInfo, GitProvider, IncrementalPR, EDIT_TYPE
+from .git_provider import GitProvider, IncrementalPR
+from pr_agent.algo.types import EDIT_TYPE, FilePatchInfo
 
 
 class GithubProvider(GitProvider):
@@ -23,6 +24,8 @@ class GithubProvider(GitProvider):
             self.installation_id = context.get("installation_id", None)
         except Exception:
             self.installation_id = None
+        self.base_url = get_settings().get("GITHUB.BASE_URL", "https://api.github.com").rstrip("/")
+        self.base_url_html = self.base_url.split("api/")[0].rstrip("/") if "api/" in self.base_url else "https://github.com"
         self.github_client = self._get_github_client()
         self.repo = None
         self.pr_num = None
@@ -33,48 +36,54 @@ class GithubProvider(GitProvider):
         self.incremental = incremental
         if pr_url and 'pull' in pr_url:
             self.set_pr(pr_url)
-            self.last_commit_id = list(self.pr.get_commits())[-1]
+            self.pr_commits = list(self.pr.get_commits())
+            if self.incremental.is_incremental:
+                self.unreviewed_files_set = dict()
+                self.get_incremental_commits()
+            self.last_commit_id = self.pr_commits[-1]
             self.pr_url = self.get_pr_url() # pr_url for github actions can be as api.github.com, so we need to get the url from the pr object
+        else:
+            self.pr_commits = None
 
     def is_supported(self, capability: str) -> bool:
         return True
 
     def get_pr_url(self) -> str:
-        return f"https://github.com/{self.repo}/pull/{self.pr_num}"
+        return self.pr.html_url
 
     def set_pr(self, pr_url: str):
         self.repo, self.pr_num = self._parse_pr_url(pr_url)
         self.pr = self._get_pr()
-        if self.incremental.is_incremental:
-            self.get_incremental_commits()
 
     def get_incremental_commits(self):
-        self.commits = list(self.pr.get_commits())
+        if not self.pr_commits:
+            self.pr_commits = list(self.pr.get_commits())
 
         self.previous_review = self.get_previous_review(full=True, incremental=True)
         if self.previous_review:
             self.incremental.commits_range = self.get_commit_range()
             # Get all files changed during the commit range
-            self.file_set = dict()
+
             for commit in self.incremental.commits_range:
                 if commit.commit.message.startswith(f"Merge branch '{self._get_repo().default_branch}'"):
                     get_logger().info(f"Skipping merge commit {commit.commit.message}")
                     continue
-                self.file_set.update({file.filename: file for file in commit.files})
+                self.unreviewed_files_set.update({file.filename: file for file in commit.files})
         else:
-            raise ValueError("No previous review found")
+            get_logger().info("No previous review found, will review the entire PR")
+            self.incremental.is_incremental = False
 
     def get_commit_range(self):
         last_review_time = self.previous_review.created_at
         first_new_commit_index = None
-        for index in range(len(self.commits) - 1, -1, -1):
+        for index in range(len(self.pr_commits) - 1, -1, -1):
-            if self.commits[index].commit.author.date > last_review_time:
+            if self.pr_commits[index].commit.author.date > last_review_time:
-                self.incremental.first_new_commit = self.commits[index]
+                self.incremental.first_new_commit = self.pr_commits[index]
                 first_new_commit_index = index
             else:
-                self.incremental.last_seen_commit = self.commits[index]
+                self.incremental.last_seen_commit = self.pr_commits[index]
                 break
-        return self.commits[first_new_commit_index:] if first_new_commit_index is not None else []
+        return self.pr_commits[first_new_commit_index:] if first_new_commit_index is not None else []
 
     def get_previous_review(self, *, full: bool, incremental: bool):
         if not (full or incremental):
@@ -83,7 +92,7 @@ class GithubProvider(GitProvider):
             self.comments = list(self.pr.get_issue_comments())
         prefixes = []
         if full:
-            prefixes.append("## PR Analysis")
+            prefixes.append("## PR Review")
         if incremental:
             prefixes.append("## Incremental PR Review")
         for index in range(len(self.comments) - 1, -1, -1):
@@ -91,12 +100,20 @@ class GithubProvider(GitProvider):
                 return self.comments[index]
 
     def get_files(self):
-        if self.incremental.is_incremental and self.file_set:
+        if self.incremental.is_incremental and self.unreviewed_files_set:
-            return self.file_set.values()
+            return self.unreviewed_files_set.values()
-        if not self.git_files:
+        try:
-            # bring files from GitHub only once
+            git_files = context.get("git_files", None)
+            if git_files:
+                return git_files
             self.git_files = self.pr.get_files()
-        return self.git_files
+            context["git_files"] = self.git_files
+            return self.git_files
+        except Exception:
+            if not self.git_files:
+                self.git_files = self.pr.get_files()
+            return self.git_files
+
 
     @retry(exceptions=RateLimitExceeded,
            tries=get_settings().github.ratelimit_retries, delay=2, backoff=2, jitter=(1, 3))
@@ -110,6 +127,13 @@ class GithubProvider(GitProvider):
             or renamed files in the merge request.
         """
         try:
+            try:
+                diff_files = context.get("diff_files", None)
+                if diff_files:
+                    return diff_files
+            except Exception:
+                pass
+
             if self.diff_files:
                 return self.diff_files
 
@@ -123,10 +147,10 @@ class GithubProvider(GitProvider):
                 new_file_content_str = self._get_pr_file_content(file, self.pr.head.sha)  # communication with GitHub
                 patch = file.patch
 
-                if self.incremental.is_incremental and self.file_set:
+                if self.incremental.is_incremental and self.unreviewed_files_set:
                     original_file_content_str = self._get_pr_file_content(file, self.incremental.last_seen_commit_sha)
                     patch = load_large_diff(file.filename, new_file_content_str, original_file_content_str)
-                    self.file_set[file.filename] = patch
+                    self.unreviewed_files_set[file.filename] = patch
                 else:
                     original_file_content_str = self._get_pr_file_content(file, self.pr.base.sha)
                     if not patch:
@@ -155,6 +179,11 @@ class GithubProvider(GitProvider):
                 diff_files.append(file_patch_canonical_structure)
 
             self.diff_files = diff_files
+            try:
+                context["diff_files"] = diff_files
+            except Exception:
+                pass
+
             return diff_files
 
         except GithubException.RateLimitExceededException as e:
@@ -170,7 +199,11 @@ class GithubProvider(GitProvider):
     def get_comment_url(self, comment) -> str:
         return comment.html_url
 
-    def publish_persistent_comment(self, pr_comment: str, initial_header: str, update_header: bool = True):
+    def publish_persistent_comment(self, pr_comment: str,
+                                   initial_header: str,
+                                   update_header: bool = True,
+                                   name='review',
+                                   final_update_message=True):
         prev_comments = list(self.pr.get_issue_comments())
         for comment in prev_comments:
             body = comment.body
@@ -178,14 +211,15 @@ class GithubProvider(GitProvider):
                 latest_commit_url = self.get_latest_commit_url()
                 comment_url = self.get_comment_url(comment)
                 if update_header:
-                    updated_header = f"{initial_header}\n\n### (review updated until commit {latest_commit_url})\n"
+                    updated_header = f"{initial_header}\n\n### ({name.capitalize()} updated until commit {latest_commit_url})\n"
                     pr_comment_updated = pr_comment.replace(initial_header, updated_header)
                 else:
                     pr_comment_updated = pr_comment
                 get_logger().info(f"Persistent mode- updating comment {comment_url} to latest review message")
                 response = comment.edit(pr_comment_updated)
-                self.publish_comment(
+                if final_update_message:
-                    f"**[Persistent review]({comment_url})** updated to latest commit {latest_commit_url}")
+                    self.publish_comment(
+                        f"**[Persistent {name}]({comment_url})** updated to latest commit {latest_commit_url}")
                 return
         self.publish_comment(pr_comment)
 
@@ -201,13 +235,18 @@ class GithubProvider(GitProvider):
         if not hasattr(self.pr, 'comments_list'):
             self.pr.comments_list = []
         self.pr.comments_list.append(response)
+        return response
 
     def publish_inline_comment(self, body: str, relevant_file: str, relevant_line_in_file: str):
         self.publish_inline_comments([self.create_inline_comment(body, relevant_file, relevant_line_in_file)])
 
 
-    def create_inline_comment(self, body: str, relevant_file: str, relevant_line_in_file: str):
+    def create_inline_comment(self, body: str, relevant_file: str, relevant_line_in_file: str,
-        position, absolute_position = find_line_number_of_relevant_line_in_file(self.diff_files, relevant_file.strip('`'), relevant_line_in_file)
+                              absolute_position: int = None):
+        position, absolute_position = find_line_number_of_relevant_line_in_file(self.diff_files,
+                                                                                relevant_file.strip('`'),
+                                                                                relevant_line_in_file,
+                                                                                absolute_position)
         if position == -1:
             if get_settings().config.verbosity_level >= 2:
                 get_logger().info(f"Could not find position for {relevant_file} {relevant_line_in_file}")
@@ -217,8 +256,114 @@ class GithubProvider(GitProvider):
         path = relevant_file.strip()
         return dict(body=body, path=path, position=position) if subject_type == "LINE" else {}
 
-    def publish_inline_comments(self, comments: list[dict]):
+    def publish_inline_comments(self, comments: list[dict], disable_fallback: bool = False):
-        self.pr.create_review(commit=self.last_commit_id, comments=comments)
+        try:
+            # publish all comments in a single message
+            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:
         """
@@ -262,13 +407,26 @@ class GithubProvider(GitProvider):
             post_parameters_list.append(post_parameters)
 
         try:
-            self.pr.create_review(commit=self.last_commit_id, comments=post_parameters_list)
+            self.publish_inline_comments(post_parameters_list)
             return True
         except Exception as e:
             if get_settings().config.verbosity_level >= 2:
                 get_logger().error(f"Failed to publish code suggestion, error: {e}")
             return False
 
+    def edit_comment(self, comment, body: str):
+        comment.edit(body=body)
+
+    def reply_to_comment_from_comment_id(self, comment_id: int, body: str):
+        try:
+            # self.pr.get_issue_comment(comment_id).edit(body)
+            headers, data_patch = self.pr._requester.requestJsonAndCheck(
+                "POST", f"{self.base_url}/repos/{self.repo}/pulls/{self.pr_num}/comments/{comment_id}/replies",
+                input={"body": body}
+            )
+        except Exception as e:
+            get_logger().exception(f"Failed to reply comment, error: {e}")
+
     def remove_initial_comment(self):
         try:
             for comment in getattr(self.pr, 'comments_list', []):
@@ -327,23 +485,31 @@ class GithubProvider(GitProvider):
         except Exception:
             return ""
 
-    def add_eyes_reaction(self, issue_comment_id: int) -> Optional[int]:
+    def add_eyes_reaction(self, issue_comment_id: int, disable_eyes: bool = False) -> Optional[int]:
+        if disable_eyes:
+            return None
         try:
-            reaction = self.pr.get_issue_comment(issue_comment_id).create_reaction("eyes")
+            headers, data_patch = self.pr._requester.requestJsonAndCheck(
-            return reaction.id
+                "POST", f"{self.base_url}/repos/{self.repo}/issues/comments/{issue_comment_id}/reactions",
+                input={"content": "eyes"}
+            )
+            return data_patch.get("id", None)
         except Exception as e:
             get_logger().exception(f"Failed to add eyes reaction, error: {e}")
             return None
 
-    def remove_reaction(self, issue_comment_id: int, reaction_id: int) -> bool:
+    def remove_reaction(self, issue_comment_id: int, reaction_id: str) -> bool:
         try:
-            self.pr.get_issue_comment(issue_comment_id).delete_reaction(reaction_id)
+            # self.pr.get_issue_comment(issue_comment_id).delete_reaction(reaction_id)
+            headers, data_patch = self.pr._requester.requestJsonAndCheck(
+                "DELETE",
+                f"{self.base_url}/repos/{self.repo}/issues/comments/{issue_comment_id}/reactions/{reaction_id}"
+            )
             return True
         except Exception as e:
             get_logger().exception(f"Failed to remove eyes reaction, error: {e}")
             return False
 
-
     @staticmethod
     def _parse_pr_url(pr_url: str) -> Tuple[str, int]:
         parsed_url = urlparse(pr_url)
@@ -415,7 +581,7 @@ class GithubProvider(GitProvider):
                 raise ValueError("GitHub app installation ID is required when using GitHub app deployment")
             auth = AppAuthentication(app_id=app_id, private_key=private_key,
                                      installation_id=self.installation_id)
-            return Github(app_auth=auth, base_url=get_settings().github.base_url)
+            return Github(app_auth=auth, base_url=self.base_url)
 
         if deployment_type == 'user':
             try:
@@ -424,7 +590,7 @@ class GithubProvider(GitProvider):
                 raise ValueError(
                     "GitHub token is required when using user deployment. See: "
                     "https://github.com/Codium-ai/pr-agent#method-2-run-from-source") from e
-            return Github(auth=Auth.Token(token), base_url=get_settings().github.base_url)
+            return Github(auth=Auth.Token(token), base_url=self.base_url)
 
     def _get_repo(self):
         if hasattr(self, 'repo_obj') and \
@@ -439,13 +605,36 @@ class GithubProvider(GitProvider):
     def _get_pr(self):
         return self._get_repo().get_pull(self.pr_num)
 
-    def _get_pr_file_content(self, file: FilePatchInfo, sha: str) -> str:
+    def get_pr_file_content(self, file_path: str, branch: str) -> str:
         try:
-            file_content_str = str(self._get_repo().get_contents(file.filename, ref=sha).decoded_content.decode())
+            file_content_str = str(
+                self._get_repo()
+                .get_contents(file_path, ref=branch)
+                .decoded_content.decode()
+            )
         except Exception:
             file_content_str = ""
         return file_content_str
 
+    def create_or_update_pr_file(
+        self, file_path: str, branch: str, contents="", message=""
+    ) -> None:
+        try:
+            file_obj = self._get_repo().get_contents(file_path, ref=branch)
+            sha1=file_obj.sha
+        except Exception:
+            sha1=""
+        self.repo_obj.update_file(
+            path=file_path,
+            message=message,
+            content=contents,
+            sha=sha1,
+            branch=branch,
+        )
+
+    def _get_pr_file_content(self, file: FilePatchInfo, sha: str) -> str:
+        return self.get_pr_file_content(file.filename, sha)
+
     def publish_labels(self, pr_types):
         try:
             label_color_map = {"Bug fix": "1d76db", "Tests": "e99695", "Bug fix with tests": "c5def5",
@@ -461,13 +650,17 @@ class GithubProvider(GitProvider):
         except Exception as e:
             get_logger().exception(f"Failed to publish labels, error: {e}")
 
-    def get_labels(self):
+    def get_pr_labels(self):
         try:
             return [label.name for label in self.pr.labels]
         except Exception as e:
             get_logger().exception(f"Failed to get labels, error: {e}")
             return []
 
+    def get_repo_labels(self):
+        labels = self.repo_obj.get_labels()
+        return [label for label in labels]
+
     def get_commit_messages(self):
         """
         Retrieves the commit messages of a pull request.
@@ -488,8 +681,8 @@ class GithubProvider(GitProvider):
 
     def generate_link_to_relevant_line_number(self, suggestion) -> str:
         try:
-            relevant_file = suggestion['relevant file'].strip('`').strip("'")
+            relevant_file = suggestion['relevant_file'].strip('`').strip("'").strip('\n')
-            relevant_line_str = suggestion['relevant line']
+            relevant_line_str = suggestion['relevant_line'].strip('\n')
             if not relevant_line_str:
                 return ""
 
@@ -503,7 +696,7 @@ class GithubProvider(GitProvider):
 
                 # link to diff
                 sha_file = hashlib.sha256(relevant_file.encode('utf-8')).hexdigest()
-                link = f"https://github.com/{self.repo}/pull/{self.pr_num}/files#diff-{sha_file}R{absolute_position}"
+                link = f"{self.base_url_html}/{self.repo}/pull/{self.pr_num}/files#diff-{sha_file}R{absolute_position}"
                 return link
         except Exception as e:
             if get_settings().config.verbosity_level >= 2:
@@ -514,11 +707,11 @@ class GithubProvider(GitProvider):
     def get_line_link(self, relevant_file: str, relevant_line_start: int, relevant_line_end: int = None) -> str:
         sha_file = hashlib.sha256(relevant_file.encode('utf-8')).hexdigest()
         if relevant_line_start == -1:
-            link = f"https://github.com/{self.repo}/pull/{self.pr_num}/files#diff-{sha_file}"
+            link = f"{self.base_url_html}/{self.repo}/pull/{self.pr_num}/files#diff-{sha_file}"
         elif relevant_line_end:
-            link = f"https://github.com/{self.repo}/pull/{self.pr_num}/files#diff-{sha_file}R{relevant_line_start}-R{relevant_line_end}"
+            link = f"{self.base_url_html}/{self.repo}/pull/{self.pr_num}/files#diff-{sha_file}R{relevant_line_start}-R{relevant_line_end}"
         else:
-            link = f"https://github.com/{self.repo}/pull/{self.pr_num}/files#diff-{sha_file}R{relevant_line_start}"
+            link = f"{self.base_url_html}/{self.repo}/pull/{self.pr_num}/files#diff-{sha_file}R{relevant_line_start}"
         return link
 
 
@@ -528,3 +721,34 @@ class GithubProvider(GitProvider):
             return pr_id
         except:
             return ""
+
+    def auto_approve(self) -> bool:
+        try:
+            res = self.pr.create_review(event="APPROVE")
+            if res.state == "APPROVED":
+                return True
+            return False
+        except Exception as e:
+            get_logger().exception(f"Failed to auto-approve, error: {e}")
+            return False
+
+    def calc_pr_statistics(self, pull_request_data: dict):
+        try:
+            out = {}
+            from datetime import datetime
+            created_at = pull_request_data['created_at']
+            closed_at = pull_request_data['closed_at']
+            closed_at_datetime = datetime.strptime(closed_at, "%Y-%m-%dT%H:%M:%SZ")
+            created_at_datetime = datetime.strptime(created_at, "%Y-%m-%dT%H:%M:%SZ")
+            difference = closed_at_datetime - created_at_datetime
+            out['hours'] = difference.total_seconds() / 3600
+            out['commits'] = pull_request_data['commits']
+            out['comments'] = pull_request_data['comments']
+            out['review_comments'] = pull_request_data['review_comments']
+            out['changed_files'] = pull_request_data['changed_files']
+            out['additions'] = pull_request_data['additions']
+            out['deletions'] = pull_request_data['deletions']
+        except Exception as e:
+            get_logger().exception(f"Failed to calculate PR statistics, error: {e}")
+            return {}
+        return out

pr_agent/git_providers/gitlab_provider.py

@@ -7,10 +7,10 @@ import gitlab
 from gitlab import GitlabGetError
 
 from ..algo.language_handler import is_valid_file
-from ..algo.pr_processing import find_line_number_of_relevant_line_in_file
+from ..algo.utils import load_large_diff, clip_tokens, find_line_number_of_relevant_line_in_file
-from ..algo.utils import load_large_diff, clip_tokens
 from ..config_loader import get_settings
-from .git_provider import EDIT_TYPE, FilePatchInfo, GitProvider
+from .git_provider import GitProvider
+from pr_agent.algo.types import EDIT_TYPE, FilePatchInfo
 from ..log import get_logger
 
 
@@ -63,7 +63,7 @@ class GitLabProvider(GitProvider):
             raise DiffNotFoundError(f"Could not get diff for merge request {self.id_mr}") from e
 
 
-    def _get_pr_file_content(self, file_path: str, branch: str) -> str:
+    def get_pr_file_content(self, file_path: str, branch: str) -> str:
         try:
             return self.gl.projects.get(self.id_project).files.get(file_path, branch).decode()
         except GitlabGetError:
@@ -88,10 +88,8 @@ class GitLabProvider(GitProvider):
         diff_files = []
         for diff in diffs:
             if is_valid_file(diff['new_path']):
-                # original_file_content_str = self._get_pr_file_content(diff['old_path'], self.mr.target_branch)
+                original_file_content_str = self.get_pr_file_content(diff['old_path'], self.mr.diff_refs['base_sha'])
-                # new_file_content_str = self._get_pr_file_content(diff['new_path'], self.mr.source_branch)
+                new_file_content_str = self.get_pr_file_content(diff['new_path'], self.mr.diff_refs['head_sha'])
-                original_file_content_str = self._get_pr_file_content(diff['old_path'], self.mr.diff_refs['base_sha'])
-                new_file_content_str = self._get_pr_file_content(diff['new_path'], self.mr.diff_refs['head_sha'])
 
                 try:
                     if isinstance(original_file_content_str, bytes):
@@ -151,21 +149,26 @@ class GitLabProvider(GitProvider):
     def get_comment_url(self, comment):
         return f"{self.mr.web_url}#note_{comment.id}"
 
-    def publish_persistent_comment(self, pr_comment: str, initial_header: str, update_header: bool = True):
+    def publish_persistent_comment(self, pr_comment: str,
+                                   initial_header: str,
+                                   update_header: bool = True,
+                                   name='review',
+                                   final_update_message=True):
         try:
             for comment in self.mr.notes.list(get_all=True)[::-1]:
                 if comment.body.startswith(initial_header):
                     latest_commit_url = self.get_latest_commit_url()
                     comment_url = self.get_comment_url(comment)
                     if update_header:
-                        updated_header = f"{initial_header}\n\n### (review updated until commit {latest_commit_url})\n"
+                        updated_header = f"{initial_header}\n\n### ({name.capitalize()} updated until commit {latest_commit_url})\n"
                         pr_comment_updated = pr_comment.replace(initial_header, updated_header)
                     else:
                         pr_comment_updated = pr_comment
-                    get_logger().info(f"Persistent mode- updating comment {comment_url} to latest review message")
+                    get_logger().info(f"Persistent mode - updating comment {comment_url} to latest {name} message")
                     response = self.mr.notes.update(comment.id, {'body': pr_comment_updated})
-                    self.publish_comment(
+                    if final_update_message:
-                        f"**[Persistent review]({comment_url})** updated to latest commit {latest_commit_url}")
+                        self.publish_comment(
+                            f"**[Persistent {name}]({comment_url})** updated to latest commit {latest_commit_url}")
                     return
         except Exception as e:
             get_logger().exception(f"Failed to update persistent review, error: {e}")
@@ -176,6 +179,14 @@ class GitLabProvider(GitProvider):
         comment = self.mr.notes.create({'body': mr_comment})
         if is_temporary:
             self.temp_comments.append(comment)
+        return comment
+
+    def edit_comment(self, comment, body: str):
+        self.mr.notes.update(comment.id,{'body': body} )
+
+    def reply_to_comment_from_comment_id(self, comment_id: int, body: str):
+        discussion = self.mr.discussions.get(comment_id)
+        discussion.notes.create({'body': body})
 
     def publish_inline_comment(self, body: str, relevant_file: str, relevant_line_in_file: str):
         edit_type, found, source_line_no, target_file, target_line_no = self.search_line(relevant_file,
@@ -183,7 +194,7 @@ class GitLabProvider(GitProvider):
         self.send_inline_comment(body, edit_type, found, relevant_file, relevant_line_in_file, source_line_no,
                                  target_file, target_line_no)
 
-    def create_inline_comment(self, body: str, relevant_file: str, relevant_line_in_file: str):
+    def create_inline_comment(self, body: str, relevant_file: str, relevant_line_in_file: str, absolute_position: int = None):
         raise NotImplementedError("Gitlab provider does not support creating inline comments yet")
 
     def create_inline_comments(self, comments: list[dict]):
@@ -211,7 +222,11 @@ class GitLabProvider(GitProvider):
                 pos_obj['new_line'] = target_line_no - 1
                 pos_obj['old_line'] = source_line_no - 1
             get_logger().debug(f"Creating comment in {self.id_mr} with body {body} and position {pos_obj}")
-            self.mr.discussions.create({'body': body, 'position': pos_obj})
+            try:
+                self.mr.discussions.create({'body': body, 'position': pos_obj})
+            except Exception as e:
+                get_logger().debug(
+                    f"Failed to create comment in {self.id_mr} with position {pos_obj} (probably not a '+' line)")
 
     def get_relevant_diff(self, relevant_file: str, relevant_line_in_file: int) -> Optional[dict]:
         changes = self.mr.changes()  # Retrieve the changes for the merge request once
@@ -356,7 +371,7 @@ class GitLabProvider(GitProvider):
         except Exception:
             return ""
 
-    def add_eyes_reaction(self, issue_comment_id: int) -> Optional[int]:
+    def add_eyes_reaction(self, issue_comment_id: int, disable_eyes: bool = False) -> Optional[int]:
         return True
 
     def remove_reaction(self, issue_comment_id: int, reaction_id: int) -> bool:
@@ -404,9 +419,12 @@ class GitLabProvider(GitProvider):
     def publish_inline_comments(self, comments: list[dict]):
         pass
 
-    def get_labels(self):
+    def get_pr_labels(self):
         return self.mr.labels
 
+    def get_repo_labels(self):
+        return self.gl.projects.get(self.id_project).labels.list()
+
     def get_commit_messages(self):
         """
         Retrieves the commit messages of a pull request.
@@ -433,18 +451,18 @@ class GitLabProvider(GitProvider):
 
     def get_line_link(self, relevant_file: str, relevant_line_start: int, relevant_line_end: int = None) -> str:
         if relevant_line_start == -1:
-            link = f"https://gitlab.com/codiumai/pr-agent/-/blob/{self.mr.source_branch}/{relevant_file}?ref_type=heads"
+            link = f"{self.gl.url}/{self.id_project}/-/blob/{self.mr.source_branch}/{relevant_file}?ref_type=heads"
         elif 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}"
+            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}"
         else:
-            link = f"https://gitlab.com/codiumai/pr-agent/-/blob/{self.mr.source_branch}/{relevant_file}?ref_type=heads#L{relevant_line_start}"
+            link = f"{self.gl.url}/{self.id_project}/-/blob/{self.mr.source_branch}/{relevant_file}?ref_type=heads#L{relevant_line_start}"
         return link
 
 
     def generate_link_to_relevant_line_number(self, suggestion) -> str:
         try:
-            relevant_file = suggestion['relevant file'].strip('`').strip("'")
+            relevant_file = suggestion['relevant_file'].strip('`').strip("'").rstrip()
-            relevant_line_str = suggestion['relevant line']
+            relevant_line_str = suggestion['relevant_line'].rstrip()
             if not relevant_line_str:
                 return ""
 
@@ -453,7 +471,7 @@ class GitLabProvider(GitProvider):
 
             if absolute_position != -1:
                 # link to right file only
-                link = f"https://gitlab.com/codiumai/pr-agent/-/blob/{self.mr.source_branch}/{relevant_file}?ref_type=heads#L{absolute_position}"
+                link = f"{self.gl.url}/{self.id_project}/-/blob/{self.mr.source_branch}/{relevant_file}?ref_type=heads#L{absolute_position}"
 
                 # # link to diff
                 # sha_file = hashlib.sha1(relevant_file.encode('utf-8')).hexdigest()

pr_agent/git_providers/local_git_provider.py

@@ -5,7 +5,8 @@ from typing import List
 from git import Repo
 
 from pr_agent.config_loader import _find_repository_root, get_settings
-from pr_agent.git_providers.git_provider import EDIT_TYPE, FilePatchInfo, GitProvider
+from pr_agent.git_providers.git_provider import GitProvider
+from pr_agent.algo.types import EDIT_TYPE, FilePatchInfo
 from pr_agent.log import get_logger
 
 
@@ -121,9 +122,6 @@ class LocalGitProvider(GitProvider):
     def publish_inline_comment(self, body: str, relevant_file: str, relevant_line_in_file: str):
         raise NotImplementedError('Publishing inline comments is not implemented for the local git provider')
 
-    def create_inline_comment(self, body: str, relevant_file: str, relevant_line_in_file: str):
-        raise NotImplementedError('Creating inline comments is not implemented for the local git provider')
-
     def publish_inline_comments(self, comments: list[dict]):
         raise NotImplementedError('Publishing inline comments is not implemented for the local git provider')
 
@@ -178,5 +176,5 @@ class LocalGitProvider(GitProvider):
     def get_issue_comments(self):
         raise NotImplementedError('Getting issue comments is not implemented for the local git provider')
 
-    def get_labels(self):
+    def get_pr_labels(self):
         raise NotImplementedError('Getting labels is not implemented for the local git provider')

pr_agent/git_providers/utils.py

@@ -7,14 +7,26 @@ from dynaconf import Dynaconf
 from pr_agent.config_loader import get_settings
 from pr_agent.git_providers import get_git_provider
 from pr_agent.log import get_logger
+from starlette_context import context
 
 
 def apply_repo_settings(pr_url):
     if get_settings().config.use_repo_settings_file:
         repo_settings_file = None
         try:
-            git_provider = get_git_provider()(pr_url)
+            try:
-            repo_settings = git_provider.get_repo_settings()
+                repo_settings = context.get("repo_settings", None)
+            except Exception:
+                repo_settings = None
+                pass
+            if repo_settings is None:  # None is different from "", which is a valid value
+                git_provider = get_git_provider()(pr_url)
+                repo_settings = git_provider.get_repo_settings()
+                try:
+                    context["repo_settings"] = repo_settings
+                except Exception:
+                    pass
+
             if repo_settings:
                 repo_settings_file = None
                 fd, repo_settings_file = tempfile.mkstemp(suffix='.toml')
@@ -26,7 +38,7 @@ def apply_repo_settings(pr_url):
                         section_dict[key] = value
                     get_settings().unset(section)
                     get_settings().set(section, section_dict, merge=False)
-                    get_logger().info(f"Applying repo settings for section {section}, contents: {contents}")
+                get_logger().info(f"Applying repo settings:\n{new_settings.as_dict()}")
         except Exception as e:
             get_logger().exception("Failed to apply repo settings", e)
         finally:

pr_agent/identity_providers/__init__.py

@@ -0,0 +1,13 @@
+from pr_agent.config_loader import get_settings
+from pr_agent.identity_providers.default_identity_provider import DefaultIdentityProvider
+
+_IDENTITY_PROVIDERS = {
+    'default': DefaultIdentityProvider
+}
+
+
+def get_identity_provider():
+    identity_provider_id = get_settings().get("CONFIG.IDENTITY_PROVIDER", "default")
+    if identity_provider_id not in _IDENTITY_PROVIDERS:
+        raise ValueError(f"Unknown identity provider: {identity_provider_id}")
+    return _IDENTITY_PROVIDERS[identity_provider_id]()

pr_agent/identity_providers/default_identity_provider.py

@@ -0,0 +1,9 @@
+from pr_agent.identity_providers.identity_provider import Eligibility, IdentityProvider
+
+
+class DefaultIdentityProvider(IdentityProvider):
+    def verify_eligibility(self, git_provider, git_provider_id, pr_url):
+        return Eligibility.ELIGIBLE
+
+    def inc_invocation_count(self, git_provider, git_provider_id):
+        pass

pr_agent/identity_providers/identity_provider.py

@@ -0,0 +1,18 @@
+from abc import ABC, abstractmethod
+from enum import Enum
+
+
+class Eligibility(Enum):
+    NOT_ELIGIBLE = 0
+    ELIGIBLE = 1
+    TRIAL = 2
+
+
+class IdentityProvider(ABC):
+    @abstractmethod
+    def verify_eligibility(self, git_provider, git_provier_id, pr_url):
+        pass
+
+    @abstractmethod
+    def inc_invocation_count(self, git_provider, git_provider_id):
+        pass

pr_agent/log/__init__.py

@@ -1,10 +1,13 @@
 import json
 import logging
+import os
 import sys
 from enum import Enum
 
 from loguru import logger
 
+from pr_agent.config_loader import get_settings
+
 
 class LoggingFormat(str, Enum):
     CONSOLE = "CONSOLE"
@@ -15,23 +18,45 @@ def json_format(record: dict) -> str:
     return record["message"]
 
 
+def analytics_filter(record: dict) -> bool:
+    return record.get("extra", {}).get("analytics", False)
+
+
+def inv_analytics_filter(record: dict) -> bool:
+    return not record.get("extra", {}).get("analytics", False)
+
+
 def setup_logger(level: str = "INFO", fmt: LoggingFormat = LoggingFormat.CONSOLE):
     level: int = logging.getLevelName(level.upper())
     if type(level) is not int:
         level = logging.INFO
 
-    if fmt == LoggingFormat.JSON:
+    if fmt == LoggingFormat.JSON and os.getenv("LOG_SANE", "0").lower() == "0":  # better debugging github_app
         logger.remove(None)
         logger.add(
             sys.stdout,
+            filter=inv_analytics_filter,
             level=level,
             format="{message}",
             colorize=False,
             serialize=True,
         )
-    elif fmt == LoggingFormat.CONSOLE:
+    elif fmt == LoggingFormat.CONSOLE: # does not print the 'extra' fields
         logger.remove(None)
-        logger.add(sys.stdout, level=level, colorize=True)
+        logger.add(sys.stdout, level=level, colorize=True, filter=inv_analytics_filter)
+
+    log_folder = get_settings().get("CONFIG.ANALYTICS_FOLDER", "")
+    if log_folder:
+        pid = os.getpid()
+        log_file = os.path.join(log_folder, f"pr-agent.{pid}.log")
+        logger.add(
+            log_file,
+            filter=analytics_filter,
+            level=level,
+            format="{message}",
+            colorize=False,
+            serialize=True,
+        )
 
     return logger
 

pr_agent/secret_providers/__init__.py

@@ -2,15 +2,18 @@ from pr_agent.config_loader import get_settings
 
 
 def get_secret_provider():
-    try:
+    if not get_settings().get("CONFIG.SECRET_PROVIDER"):
-        provider_id = get_settings().config.secret_provider
+        return None
-    except AttributeError as e:
+
-        raise ValueError("secret_provider is a required attribute in the configuration file") from e
+    provider_id = get_settings().config.secret_provider
-    try:
+    if provider_id == 'google_cloud_storage':
-        if provider_id == 'google_cloud_storage':
+        try:
             from pr_agent.secret_providers.google_cloud_storage_secret_provider import GoogleCloudStorageSecretProvider
             return GoogleCloudStorageSecretProvider()
-        else:
+        except Exception as e:
-            raise ValueError(f"Unknown secret provider: {provider_id}")
+            raise ValueError(f"Failed to initialize google_cloud_storage secret provider {provider_id}") from e
-    except Exception as e:
+    else:
-        raise ValueError(f"Failed to initialize secret provider {provider_id}") from e
+        raise ValueError("Unknown SECRET_PROVIDER")
+
+
+

pr_agent/servers/azuredevops_server_webhook.py

@@ -0,0 +1,139 @@
+# This file contains the code for the Azure DevOps Server webhook server.
+# The server listens for incoming webhooks from Azure DevOps Server and forwards them to the PR Agent.
+# ADO webhook documentation: https://learn.microsoft.com/en-us/azure/devops/service-hooks/services/webhooks?view=azure-devops
+
+import json
+import os
+import re
+import secrets
+from urllib.parse import unquote
+
+import uvicorn
+from fastapi import APIRouter, Depends, FastAPI, HTTPException
+from fastapi.security import HTTPBasic, HTTPBasicCredentials
+from fastapi.encoders import jsonable_encoder
+from starlette import status
+from starlette.background import BackgroundTasks
+from starlette.middleware import Middleware
+from starlette.requests import Request
+from starlette.responses import JSONResponse
+from starlette_context.middleware import RawContextMiddleware
+
+from pr_agent.agent.pr_agent import PRAgent, command2class
+from pr_agent.algo.utils import update_settings_from_args
+from pr_agent.config_loader import get_settings
+from pr_agent.git_providers.utils import apply_repo_settings
+from pr_agent.log import get_logger
+from fastapi import Request, Depends
+from fastapi.security import HTTPBasic, HTTPBasicCredentials
+from pr_agent.log import get_logger
+
+security = HTTPBasic()
+router = APIRouter()
+available_commands_rgx = re.compile(r"^\/(" + "|".join(command2class.keys()) + r")\s*")
+azure_devops_server = get_settings().get("azure_devops_server")
+WEBHOOK_USERNAME = azure_devops_server.get("webhook_username")
+WEBHOOK_PASSWORD = azure_devops_server.get("webhook_password")
+
+def handle_request(
+    background_tasks: BackgroundTasks, url: str, body: str, log_context: dict
+):
+    log_context["action"] = body
+    log_context["api_url"] = url
+    with get_logger().contextualize(**log_context):
+        background_tasks.add_task(PRAgent().handle_request, url, body)
+
+
+# currently only basic auth is supported with azure webhooks
+# for this reason, https must be enabled to ensure the credentials are not sent in clear text
+def authorize(credentials: HTTPBasicCredentials = Depends(security)):
+        is_user_ok = secrets.compare_digest(credentials.username, WEBHOOK_USERNAME)
+        is_pass_ok = secrets.compare_digest(credentials.password, WEBHOOK_PASSWORD)
+        if not (is_user_ok and is_pass_ok):
+            raise HTTPException(
+                status_code=status.HTTP_401_UNAUTHORIZED,
+                detail='Incorrect username or password.',
+                headers={'WWW-Authenticate': 'Basic'},
+            )
+
+
+async def _perform_commands_azure(commands_conf: str, agent: PRAgent, api_url: str, log_context: dict):
+    apply_repo_settings(api_url)
+    commands = get_settings().get(f"azure_devops_server.{commands_conf}")
+    for command in commands:
+        try:
+            split_command = command.split(" ")
+            command = split_command[0]
+            args = split_command[1:]
+            other_args = update_settings_from_args(args)
+            new_command = ' '.join([command] + other_args)
+            get_logger().info(f"Performing command: {new_command}")
+            with get_logger().contextualize(**log_context):
+                await agent.handle_request(api_url, new_command)
+        except Exception as e:
+            get_logger().error(f"Failed to perform command {command}: {e}")
+
+
+@router.post("/", dependencies=[Depends(authorize)])
+async def handle_webhook(background_tasks: BackgroundTasks, request: Request):
+    log_context = {"server_type": "azure_devops_server"}
+    data = await request.json()
+    get_logger().info(json.dumps(data))
+
+    actions = []
+    if data["eventType"] == "git.pullrequest.created": 
+        # API V1 (latest)
+        pr_url = unquote(data["resource"]["_links"]["web"]["href"].replace("_apis/git/repositories", "_git"))
+        log_context["event"] = data["eventType"]
+        log_context["api_url"] = pr_url
+        await _perform_commands_azure("pr_commands", PRAgent(), pr_url, log_context)
+        return
+    elif data["eventType"] == "ms.vss-code.git-pullrequest-comment-event" and "content" in data["resource"]["comment"]:
+        if available_commands_rgx.match(data["resource"]["comment"]["content"]):
+            if(data["resourceVersion"] == "2.0"):
+                repo = data["resource"]["pullRequest"]["repository"]["webUrl"]
+                pr_url = unquote(f'{repo}/pullrequest/{data["resource"]["pullRequest"]["pullRequestId"]}')
+                actions = [data["resource"]["comment"]["content"]]
+            else: 
+                # API V1 not supported as it does not contain the PR URL
+                return JSONResponse(
+                    status_code=status.HTTP_400_BAD_REQUEST,
+                    content=json.dumps({"message": "version 1.0 webhook for Azure Devops PR comment is not supported. please upgrade to version 2.0"})),
+        else:
+            return JSONResponse(
+                status_code=status.HTTP_400_BAD_REQUEST,
+                content=json.dumps({"message": "Unsupported command"}),
+            )
+    else:
+        return JSONResponse(
+            status_code=status.HTTP_204_NO_CONTENT,
+            content=json.dumps({"message": "Unsupported event"}),
+        )
+
+    log_context["event"] = data["eventType"]
+    log_context["api_url"] = pr_url
+    
+    for action in actions:
+        try:
+            handle_request(background_tasks, pr_url, action, log_context)
+        except Exception as e:
+            get_logger().error("Azure DevOps Trigger failed. Error:" + str(e))
+            return JSONResponse(
+                status_code=status.HTTP_500_INTERNAL_SERVER_ERROR,
+                content=json.dumps({"message": "Internal server error"}),
+            )
+    return JSONResponse(
+        status_code=status.HTTP_202_ACCEPTED, content=jsonable_encoder({"message": "webhook triggerd successfully"})
+    )
+
+@router.get("/")
+async def root():
+    return {"status": "ok"}
+    
+def start():
+    app = FastAPI(middleware=[Middleware(RawContextMiddleware)])
+    app.include_router(router)
+    uvicorn.run(app, host="0.0.0.0", port=int(os.environ.get("PORT", "3000")))
+
+if __name__ == "__main__":
+    start()

pr_agent/servers/bitbucket_app.py

@@ -1,3 +1,4 @@
+import base64
 import copy
 import hashlib
 import json
@@ -15,13 +16,22 @@ from starlette_context import context
 from starlette_context.middleware import RawContextMiddleware
 
 from pr_agent.agent.pr_agent import PRAgent
+from pr_agent.algo.utils import update_settings_from_args
 from pr_agent.config_loader import get_settings, global_settings
+from pr_agent.git_providers.utils import apply_repo_settings
+from pr_agent.identity_providers import get_identity_provider
+from pr_agent.identity_providers.identity_provider import Eligibility
 from pr_agent.log import LoggingFormat, get_logger, setup_logger
 from pr_agent.secret_providers import get_secret_provider
+from pr_agent.servers.github_action_runner import get_setting_or_env, is_true
+from pr_agent.tools.pr_code_suggestions import PRCodeSuggestions
+from pr_agent.tools.pr_description import PRDescription
+from pr_agent.tools.pr_reviewer import PRReviewer
 
-setup_logger(fmt=LoggingFormat.JSON)
+setup_logger(fmt=LoggingFormat.JSON, level="DEBUG")
 router = APIRouter()
-secret_provider = get_secret_provider()
+secret_provider = get_secret_provider() if get_settings().get("CONFIG.SECRET_PROVIDER") else None
+
 
 async def get_bearer_token(shared_secret: str, client_key: str):
     try:
@@ -63,6 +73,24 @@ async def handle_manifest(request: Request, response: Response):
     manifest_obj = json.loads(manifest)
     return JSONResponse(manifest_obj)
 
+
+async def _perform_commands_bitbucket(commands_conf: str, agent: PRAgent, api_url: str, log_context: dict):
+    apply_repo_settings(api_url)
+    commands = get_settings().get(f"bitbucket_app.{commands_conf}", {})
+    for command in commands:
+        try:
+            split_command = command.split(" ")
+            command = split_command[0]
+            args = split_command[1:]
+            other_args = update_settings_from_args(args)
+            new_command = ' '.join([command] + other_args)
+            get_logger().info(f"Performing command: {new_command}")
+            with get_logger().contextualize(**log_context):
+                await agent.handle_request(api_url, new_command)
+        except Exception as e:
+            get_logger().error(f"Failed to perform command {command}: {e}")
+
+
 @router.post("/webhook")
 async def handle_github_webhooks(background_tasks: BackgroundTasks, request: Request):
     log_context = {"server_type": "bitbucket_app"}
@@ -74,11 +102,27 @@ async def handle_github_webhooks(background_tasks: BackgroundTasks, request: Req
     get_logger().debug(data)
     async def inner():
         try:
-            owner = data["data"]["repository"]["owner"]["username"]
+            try:
+                if data["data"]["actor"]["type"] != "user":
+                    return "OK"
+            except KeyError:
+                get_logger().error("Failed to get actor type, check previous logs, this shouldn't happen.")
+            try:
+                owner = data["data"]["repository"]["owner"]["username"]
+            except Exception as e:
+                get_logger().error(f"Failed to get owner, will continue: {e}")
+                owner = "unknown"
+            sender_id = data["data"]["actor"]["account_id"]
             log_context["sender"] = owner
-            secrets = json.loads(secret_provider.get_secret(owner))
+            log_context["sender_id"] = sender_id
+            jwt_parts = input_jwt.split(".")
+            claim_part = jwt_parts[1]
+            claim_part += "=" * (-len(claim_part) % 4)
+            decoded_claims = base64.urlsafe_b64decode(claim_part)
+            claims = json.loads(decoded_claims)
+            client_key = claims["iss"]
+            secrets = json.loads(secret_provider.get_secret(client_key))
             shared_secret = secrets["shared_secret"]
-            client_key = secrets["client_key"]
             jwt.decode(input_jwt, shared_secret, audience=client_key, algorithms=["HS256"])
             bearer_token = await get_bearer_token(shared_secret, client_key)
             context['bitbucket_bearer_token'] = bearer_token
@@ -89,15 +133,32 @@ async def handle_github_webhooks(background_tasks: BackgroundTasks, request: Req
                 pr_url = data["data"]["pullrequest"]["links"]["html"]["href"]
                 log_context["api_url"] = pr_url
                 log_context["event"] = "pull_request"
-                with get_logger().contextualize(**log_context):
+                if pr_url:
-                    await agent.handle_request(pr_url, "review")
+                    with get_logger().contextualize(**log_context):
+                        apply_repo_settings(pr_url)
+                        if get_identity_provider().verify_eligibility("bitbucket",
+                                                        sender_id, pr_url) is not Eligibility.NOT_ELIGIBLE:
+                            if get_settings().get("bitbucket_app.pr_commands"):
+                                await _perform_commands_bitbucket("pr_commands", PRAgent(), pr_url, log_context)
+                            else: # backwards compatibility
+                                auto_review = get_setting_or_env("BITBUCKET_APP.AUTO_REVIEW", None)
+                                if is_true(auto_review):  # by default, auto review is disabled
+                                    await PRReviewer(pr_url).run()
+                                auto_improve = get_setting_or_env("BITBUCKET_APP.AUTO_IMPROVE", None)
+                                if is_true(auto_improve):  # by default, auto improve is disabled
+                                    await PRCodeSuggestions(pr_url).run()
+                                auto_describe = get_setting_or_env("BITBUCKET_APP.AUTO_DESCRIBE", None)
+                                if is_true(auto_describe):  # by default, auto describe is disabled
+                                    await PRDescription(pr_url).run()
             elif event == "pullrequest:comment_created":
                 pr_url = data["data"]["pullrequest"]["links"]["html"]["href"]
                 log_context["api_url"] = pr_url
                 log_context["event"] = "comment"
                 comment_body = data["data"]["comment"]["content"]["raw"]
                 with get_logger().contextualize(**log_context):
-                    await agent.handle_request(pr_url, comment_body)
+                    if get_identity_provider().verify_eligibility("bitbucket",
+                                                                     sender_id, pr_url) is not Eligibility.NOT_ELIGIBLE:
+                        await agent.handle_request(pr_url, comment_body)
         except Exception as e:
             get_logger().error(f"Failed to handle webhook: {e}")
     background_tasks.add_task(inner)

pr_agent/servers/bitbucket_server_webhook.py

@@ -1,4 +1,5 @@
 import json
+import os
 
 import uvicorn
 from fastapi import APIRouter, FastAPI
@@ -13,35 +14,55 @@ from starlette_context.middleware import RawContextMiddleware
 from pr_agent.agent.pr_agent import PRAgent
 from pr_agent.config_loader import get_settings
 from pr_agent.log import get_logger
+from pr_agent.servers.utils import verify_signature
 
 router = APIRouter()
 
 
-def handle_request(background_tasks: BackgroundTasks, url: str, body: str, log_context: dict):
+def handle_request(
+    background_tasks: BackgroundTasks, url: str, body: str, log_context: dict
+):
     log_context["action"] = body
-    log_context["event"] = "pull_request" if body == "review" else "comment"
     log_context["api_url"] = url
     with get_logger().contextualize(**log_context):
         background_tasks.add_task(PRAgent().handle_request, url, body)
 
 
-@router.post("/webhook")
+@router.post("/")
 async def handle_webhook(background_tasks: BackgroundTasks, request: Request):
     log_context = {"server_type": "bitbucket_server"}
     data = await request.json()
     get_logger().info(json.dumps(data))
 
-    pr_id = data['pullRequest']['id']
+    webhook_secret = get_settings().get("BITBUCKET_SERVER.WEBHOOK_SECRET", None)
-    repository_name = data['pullRequest']['toRef']['repository']['slug']
+    if webhook_secret:
-    project_name = data['pullRequest']['toRef']['repository']['project']['key']
+        body_bytes = await request.body()
+        signature_header = request.headers.get("x-hub-signature", None)
+        verify_signature(body_bytes, webhook_secret, signature_header)
+
+    pr_id = data["pullRequest"]["id"]
+    repository_name = data["pullRequest"]["toRef"]["repository"]["slug"]
+    project_name = data["pullRequest"]["toRef"]["repository"]["project"]["key"]
     bitbucket_server = get_settings().get("BITBUCKET_SERVER.URL")
     pr_url = f"{bitbucket_server}/projects/{project_name}/repos/{repository_name}/pull-requests/{pr_id}"
 
     log_context["api_url"] = pr_url
     log_context["event"] = "pull_request"
 
-    handle_request(background_tasks, pr_url, "review", log_context)
+    if data["eventKey"] == "pr:opened":
-    return JSONResponse(status_code=status.HTTP_200_OK, content=jsonable_encoder({"message": "success"}))
+        body = "review"
+    elif data["eventKey"] == "pr:comment:added":
+        body = data["comment"]["text"]
+    else:
+        return JSONResponse(
+            status_code=status.HTTP_400_BAD_REQUEST,
+            content=json.dumps({"message": "Unsupported event"}),
+        )
+
+    handle_request(background_tasks, pr_url, body, log_context)
+    return JSONResponse(
+        status_code=status.HTTP_200_OK, content=jsonable_encoder({"message": "success"})
+    )
 
 
 @router.get("/")
@@ -50,15 +71,10 @@ async def root():
 
 
 def start():
-    bitbucket_server_url = get_settings().get("BITBUCKET_SERVER.URL", None)
+    app = FastAPI(middleware=[Middleware(RawContextMiddleware)])
-    if not bitbucket_server_url:
-        raise ValueError("BITBUCKET_SERVER.URL is not set")
-    get_settings().config.git_provider = "bitbucket_server"
-    middleware = [Middleware(RawContextMiddleware)]
-    app = FastAPI(middleware=middleware)
     app.include_router(router)
-    uvicorn.run(app, host="0.0.0.0", port=3000)
+    uvicorn.run(app, host="0.0.0.0", port=int(os.environ.get("PORT", "3000")))
 
 
-if __name__ == '__main__':
+if __name__ == "__main__":
     start()

pr_agent/servers/github_action_runner.py

@@ -8,6 +8,7 @@ from pr_agent.config_loader import get_settings
 from pr_agent.git_providers import get_git_provider
 from pr_agent.git_providers.utils import apply_repo_settings
 from pr_agent.log import get_logger
+from pr_agent.servers.github_app import handle_line_comments
 from pr_agent.tools.pr_code_suggestions import PRCodeSuggestions
 from pr_agent.tools.pr_description import PRDescription
 from pr_agent.tools.pr_reviewer import PRReviewer
@@ -79,38 +80,61 @@ async def run_action():
     # Handle pull request event
     if GITHUB_EVENT_NAME == "pull_request":
         action = event_payload.get("action")
-        if action in ["opened", "reopened"]:
+        if action in ["opened", "reopened", "ready_for_review", "review_requested"]:
             pr_url = event_payload.get("pull_request", {}).get("url")
             if pr_url:
+                # legacy - supporting both GITHUB_ACTION and GITHUB_ACTION_CONFIG
                 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):
                     await PRReviewer(pr_url).run()
-                auto_describe = get_setting_or_env("GITHUB_ACTION.AUTO_DESCRIBE", None)
+                if auto_improve is None or is_true(auto_improve):
-                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()
 
     # Handle issue comment event
-    elif GITHUB_EVENT_NAME == "issue_comment":
+    elif GITHUB_EVENT_NAME == "issue_comment" or GITHUB_EVENT_NAME == "pull_request_review_comment":
         action = event_payload.get("action")
         if action in ["created", "edited"]:
             comment_body = event_payload.get("comment", {}).get("body")
+            try:
+                if GITHUB_EVENT_NAME == "pull_request_review_comment":
+                    if '/ask' in comment_body:
+                        comment_body = handle_line_comments(event_payload, comment_body)
+            except Exception as e:
+                get_logger().error(f"Failed to handle line comments: {e}")
+                return
             if comment_body:
                 is_pr = False
+                disable_eyes = False
                 # check if issue is pull request
                 if event_payload.get("issue", {}).get("pull_request"):
                     url = event_payload.get("issue", {}).get("pull_request", {}).get("url")
                     is_pr = True
+                elif event_payload.get("comment", {}).get("pull_request_url"): # for 'pull_request_review_comment
+                    url = event_payload.get("comment", {}).get("pull_request_url")
+                    is_pr = True
+                    disable_eyes = True
                 else:
                     url = event_payload.get("issue", {}).get("url")
+
                 if url:
                     body = comment_body.strip().lower()
                     comment_id = event_payload.get("comment", {}).get("id")
                     provider = get_git_provider()(pr_url=url)
                     if is_pr:
-                        await PRAgent().handle_request(url, body, notify=lambda: provider.add_eyes_reaction(comment_id))
+                        await PRAgent().handle_request(url, body,
+                                    notify=lambda: provider.add_eyes_reaction(comment_id, disable_eyes=disable_eyes))
                     else:
                         await PRAgent().handle_request(url, body)
 

pr_agent/servers/github_app.py

@@ -1,7 +1,9 @@
+import asyncio.locks
 import copy
 import os
-import asyncio.locks
+import re
-from typing import Any, Dict, List, Tuple
+import uuid
+from typing import Any, Dict, Tuple
 
 import uvicorn
 from fastapi import APIRouter, FastAPI, HTTPException, Request, Response
@@ -13,13 +15,21 @@ from pr_agent.agent.pr_agent import PRAgent
 from pr_agent.algo.utils import update_settings_from_args
 from pr_agent.config_loader import get_settings, global_settings
 from pr_agent.git_providers import get_git_provider
-from pr_agent.git_providers.utils import apply_repo_settings
 from pr_agent.git_providers.git_provider import IncrementalPR
+from pr_agent.git_providers.utils import apply_repo_settings
+from pr_agent.identity_providers import get_identity_provider
+from pr_agent.identity_providers.identity_provider import Eligibility
 from pr_agent.log import LoggingFormat, get_logger, setup_logger
-from pr_agent.servers.utils import verify_signature, DefaultDictWithTimeout
+from pr_agent.servers.utils import DefaultDictWithTimeout, verify_signature
-
-setup_logger(fmt=LoggingFormat.JSON)
 
+setup_logger(fmt=LoggingFormat.JSON, level="DEBUG")
+base_path = os.path.dirname(os.path.dirname(os.path.realpath(__file__)))
+build_number_path = os.path.join(base_path, "build_number.txt")
+if os.path.exists(build_number_path):
+    with open(build_number_path) as f:
+        build_number = f.read().strip()
+else:
+    build_number = "unknown"
 router = APIRouter()
 
 
@@ -34,7 +44,6 @@ async def handle_github_webhooks(request: Request, response: Response):
 
     body = await get_body(request)
 
-    get_logger().debug(f'Request body:\n{body}')
     installation_id = body.get("installation", {}).get("id")
     context["installation_id"] = installation_id
     context["settings"] = copy.deepcopy(global_settings)
@@ -63,10 +72,172 @@ async def get_body(request):
     return body
 
 
-_duplicate_requests_cache = DefaultDictWithTimeout(ttl=get_settings().github_app.duplicate_requests_cache_ttl)
 _duplicate_push_triggers = DefaultDictWithTimeout(ttl=get_settings().github_app.push_trigger_pending_tasks_ttl)
 _pending_task_duplicate_push_conditions = DefaultDictWithTimeout(asyncio.locks.Condition, ttl=get_settings().github_app.push_trigger_pending_tasks_ttl)
 
+async def handle_comments_on_pr(body: Dict[str, Any],
+                                event: str,
+                                sender: str,
+                                sender_id: str,
+                                action: str,
+                                log_context: Dict[str, Any],
+                                agent: PRAgent):
+    if "comment" not in body:
+        return {}
+    comment_body = body.get("comment", {}).get("body")
+    if comment_body and isinstance(comment_body, str) and not comment_body.lstrip().startswith("/"):
+        get_logger().info("Ignoring comment not starting with /")
+        return {}
+    disable_eyes = False
+    if "issue" in body and "pull_request" in body["issue"] and "url" in body["issue"]["pull_request"]:
+        api_url = body["issue"]["pull_request"]["url"]
+    elif "comment" in body and "pull_request_url" in body["comment"]:
+        api_url = body["comment"]["pull_request_url"]
+        try:
+            if ('/ask' in comment_body and
+                    'subject_type' in body["comment"] and body["comment"]["subject_type"] == "line"):
+                # comment on a code line in the "files changed" tab
+                comment_body = handle_line_comments(body, comment_body)
+                disable_eyes = True
+        except Exception as e:
+            get_logger().error(f"Failed to handle line comments: {e}")
+    else:
+        return {}
+    log_context["api_url"] = api_url
+    comment_id = body.get("comment", {}).get("id")
+    provider = get_git_provider()(pr_url=api_url)
+    with get_logger().contextualize(**log_context):
+        if get_identity_provider().verify_eligibility("github", sender_id, api_url) is not Eligibility.NOT_ELIGIBLE:
+            get_logger().info(f"Processing comment on PR {api_url=}, comment_body={comment_body}")
+            await agent.handle_request(api_url, comment_body,
+                        notify=lambda: provider.add_eyes_reaction(comment_id, disable_eyes=disable_eyes))
+        else:
+            get_logger().info(f"User {sender=} is not eligible to process comment on PR {api_url=}")
+
+async def handle_new_pr_opened(body: Dict[str, Any],
+                               event: str,
+                               sender: str,
+                               sender_id: str,
+                               action: str,
+                               log_context: Dict[str, Any],
+                               agent: PRAgent):
+    title = body.get("pull_request", {}).get("title", "")
+
+    # logic to ignore PRs with specific titles (e.g. "[Auto] ...")
+    ignore_pr_title_re = get_settings().get("GITHUB_APP.IGNORE_PR_TITLE", [])
+    if not isinstance(ignore_pr_title_re, list):
+        ignore_pr_title_re = [ignore_pr_title_re]
+    if ignore_pr_title_re and any(re.search(regex, title) for regex in ignore_pr_title_re):
+        get_logger().info(f"Ignoring PR with title '{title}' due to github_app.ignore_pr_title setting")
+        return {}
+
+    pull_request, api_url = _check_pull_request_event(action, body, log_context)
+    if not (pull_request and api_url):
+        get_logger().info(f"Invalid PR event: {action=} {api_url=}")
+        return {}
+    if action in get_settings().github_app.handle_pr_actions:  # ['opened', 'reopened', 'ready_for_review', 'review_requested']
+        if get_identity_provider().verify_eligibility("github", sender_id, api_url) is not Eligibility.NOT_ELIGIBLE:
+            await _perform_auto_commands_github("pr_commands", agent, body, api_url, log_context)
+        else:
+            get_logger().info(f"User {sender=} is not eligible to process PR {api_url=}")
+
+async def handle_push_trigger_for_new_commits(body: Dict[str, Any],
+                        event: str,
+                        sender: str,
+                        sender_id: str,
+                        action: str,
+                        log_context: Dict[str, Any],
+                        agent: PRAgent):
+    pull_request, api_url = _check_pull_request_event(action, body, log_context)
+    if not (pull_request and api_url):
+        return {}
+
+    apply_repo_settings(api_url) # we need to apply the repo settings to get the correct settings for the PR. This is quite expensive - a call to the git provider is made for each PR event.
+    if not get_settings().github_app.handle_push_trigger:
+        return {}
+
+    # TODO: do we still want to get the list of commits to filter bot/merge commits?
+    before_sha = body.get("before")
+    after_sha = body.get("after")
+    merge_commit_sha = pull_request.get("merge_commit_sha")
+    if before_sha == after_sha:
+        return {}
+    if get_settings().github_app.push_trigger_ignore_merge_commits and after_sha == merge_commit_sha:
+        return {}
+
+    # Prevent triggering multiple times for subsequent push triggers when one is enough:
+    # The first push will trigger the processing, and if there's a second push in the meanwhile it will wait.
+    # Any more events will be discarded, because they will all trigger the exact same processing on the PR.
+    # We let the second event wait instead of discarding it because while the first event was being processed,
+    # more commits may have been pushed that led to the subsequent events,
+    # so we keep just one waiting as a delegate to trigger the processing for the new commits when done waiting.
+    current_active_tasks = _duplicate_push_triggers.setdefault(api_url, 0)
+    max_active_tasks = 2 if get_settings().github_app.push_trigger_pending_tasks_backlog else 1
+    if current_active_tasks < max_active_tasks:
+        # first task can enter, and second tasks too if backlog is enabled
+        get_logger().info(
+            f"Continue processing push trigger for {api_url=} because there are {current_active_tasks} active tasks"
+        )
+        _duplicate_push_triggers[api_url] += 1
+    else:
+        get_logger().info(
+            f"Skipping push trigger for {api_url=} because another event already triggered the same processing"
+        )
+        return {}
+    async with _pending_task_duplicate_push_conditions[api_url]:
+        if current_active_tasks == 1:
+            # second task waits
+            get_logger().info(
+                f"Waiting to process push trigger for {api_url=} because the first task is still in progress"
+            )
+            await _pending_task_duplicate_push_conditions[api_url].wait()
+            get_logger().info(f"Finished waiting to process push trigger for {api_url=} - continue with flow")
+
+    try:
+        if get_settings().github_app.push_trigger_wait_for_initial_review and not get_git_provider()(api_url,
+                                                                                                     incremental=IncrementalPR(
+                                                                                                             True)).previous_review:
+            get_logger().info(f"Skipping incremental review because there was no initial review for {api_url=} yet")
+            return {}
+        if get_identity_provider().verify_eligibility("github", sender_id, api_url) is not Eligibility.NOT_ELIGIBLE:
+            get_logger().info(f"Performing incremental review for {api_url=} because of {event=} and {action=}")
+            await _perform_auto_commands_github("push_commands", agent, body, api_url, log_context)
+
+    finally:
+        # release the waiting task block
+        async with _pending_task_duplicate_push_conditions[api_url]:
+            _pending_task_duplicate_push_conditions[api_url].notify(1)
+            _duplicate_push_triggers[api_url] -= 1
+
+
+def handle_closed_pr(body, event, action, log_context):
+    pull_request = body.get("pull_request", {})
+    is_merged = pull_request.get("merged", False)
+    if not is_merged:
+        return
+    api_url = pull_request.get("url", "")
+    pr_statistics = get_git_provider()(pr_url=api_url).calc_pr_statistics(pull_request)
+    log_context["api_url"] = api_url
+    get_logger().info("PR-Agent statistics for closed PR", analytics=True, pr_statistics=pr_statistics, **log_context)
+
+
+def get_log_context(body, event, action, build_number):
+    sender = ""
+    sender_id = ""
+    try:
+        sender = body.get("sender", {}).get("login")
+        sender_id = body.get("sender", {}).get("id")
+        repo = body.get("repository", {}).get("full_name", "")
+        git_org = body.get("organization", {}).get("login", "")
+        app_name = get_settings().get("CONFIG.APP_NAME", "Unknown")
+        log_context = {"action": action, "event": event, "sender": sender, "server_type": "github_app",
+                       "request_id": uuid.uuid4().hex, "build_number": build_number, "app_name": app_name,
+                       "repo": repo, "git_org": git_org}
+    except Exception as e:
+        get_logger().error("Failed to get log context", e)
+        log_context = {}
+    return log_context, sender, sender_id
+
 
 async def handle_request(body: Dict[str, Any], event: str):
     """
@@ -74,119 +245,52 @@ async def handle_request(body: Dict[str, Any], event: str):
 
     Args:
         body: The request body.
-        event: The GitHub event type.
+        event: The GitHub event type (e.g. "pull_request", "issue_comment", etc.).
     """
-    action = body.get("action")
+    action = body.get("action") # "created", "opened", "reopened", "ready_for_review", "review_requested", "synchronize"
     if not action:
         return {}
     agent = PRAgent()
-    bot_user = get_settings().github_app.bot_user
+    log_context, sender, sender_id = get_log_context(body, event, action, build_number)
-    sender = body.get("sender", {}).get("login")
-    log_context = {"action": action, "event": event, "sender": sender, "server_type": "github_app"}
 
-    if get_settings().github_app.duplicate_requests_cache and _is_duplicate_request(body):
+    # handle comments on PRs
-        return {}
-
-    # handle all sorts of comment events (e.g. issue_comment)
     if action == 'created':
-        if "comment" not in body:
+        get_logger().debug(f'Request body', artifact=body, event=event)
-            return {}
+        await handle_comments_on_pr(body, event, sender, sender_id, action, log_context, agent)
-        comment_body = body.get("comment", {}).get("body")
+    # handle new PRs
-        if sender and bot_user in sender:
+    elif event == 'pull_request' and action != 'synchronize' and action != 'closed':
-            get_logger().info(f"Ignoring comment from {bot_user} user")
+        get_logger().debug(f'Request body', artifact=body, event=event)
-            return {}
+        await handle_new_pr_opened(body, event, sender, sender_id, action, log_context, agent)
-        get_logger().info(f"Processing comment from {sender} user")
-        if "issue" in body and "pull_request" in body["issue"] and "url" in body["issue"]["pull_request"]:
-            api_url = body["issue"]["pull_request"]["url"]
-        elif "comment" in body and "pull_request_url" in body["comment"]:
-            api_url = body["comment"]["pull_request_url"]
-        else:
-            return {}
-        log_context["api_url"] = api_url
-        get_logger().info(body)
-        get_logger().info(f"Handling comment because of event={event} and action={action}")
-        comment_id = body.get("comment", {}).get("id")
-        provider = get_git_provider()(pr_url=api_url)
-        with get_logger().contextualize(**log_context):
-            await agent.handle_request(api_url, comment_body, notify=lambda: provider.add_eyes_reaction(comment_id))
-
-    # handle pull_request event:
-    #   automatically review opened/reopened/ready_for_review PRs as long as they're not in draft,
-    #   as well as direct review requests from the bot
-    elif event == 'pull_request' and action != 'synchronize':
-        pull_request, api_url = _check_pull_request_event(action, body, log_context, bot_user)
-        if not (pull_request and api_url):
-            return {}
-        if action in get_settings().github_app.handle_pr_actions:
-            if action == "review_requested":
-                if body.get("requested_reviewer", {}).get("login", "") != bot_user:
-                    return {}
-            get_logger().info(f"Performing review for {api_url=} because of {event=} and {action=}")
-            await _perform_commands("pr_commands", agent, body, api_url, log_context)
-
     # handle pull_request event with synchronize action - "push trigger" for new commits
-    elif event == 'pull_request' and action == 'synchronize' and get_settings().github_app.handle_push_trigger:
+    elif event == 'pull_request' and action == 'synchronize':
-        pull_request, api_url = _check_pull_request_event(action, body, log_context, bot_user)
+        get_logger().debug(f'Request body', artifact=body, event=event)
-        if not (pull_request and api_url):
+        await handle_push_trigger_for_new_commits(body, event, sender, sender_id, action, log_context, agent)
-            return {}
+    elif event == 'pull_request' and action == 'closed':
-
+        if get_settings().get("CONFIG.ANALYTICS_FOLDER", ""):
-        # TODO: do we still want to get the list of commits to filter bot/merge commits?
+            handle_closed_pr(body, event, action, log_context)
-        before_sha = body.get("before")
+    else:
-        after_sha = body.get("after")
+        get_logger().info(f"event {event=} action {action=} does not require any handling")
-        merge_commit_sha = pull_request.get("merge_commit_sha")
-        if before_sha == after_sha:
-            return {}
-        if get_settings().github_app.push_trigger_ignore_merge_commits and after_sha == merge_commit_sha:
-            return {}
-        if get_settings().github_app.push_trigger_ignore_bot_commits and body.get("sender", {}).get("login", "") == bot_user:
-            return {}
-
-        # Prevent triggering multiple times for subsequent push triggers when one is enough:
-        # The first push will trigger the processing, and if there's a second push in the meanwhile it will wait.
-        # Any more events will be discarded, because they will all trigger the exact same processing on the PR.
-        # We let the second event wait instead of discarding it because while the first event was being processed,
-        # more commits may have been pushed that led to the subsequent events,
-        # so we keep just one waiting as a delegate to trigger the processing for the new commits when done waiting.
-        current_active_tasks = _duplicate_push_triggers.setdefault(api_url, 0)
-        max_active_tasks = 2 if get_settings().github_app.push_trigger_pending_tasks_backlog else 1
-        if current_active_tasks < max_active_tasks:
-            # first task can enter, and second tasks too if backlog is enabled
-            get_logger().info(
-                f"Continue processing push trigger for {api_url=} because there are {current_active_tasks} active tasks"
-            )
-            _duplicate_push_triggers[api_url] += 1
-        else:
-            get_logger().info(
-                f"Skipping push trigger for {api_url=} because another event already triggered the same processing"
-            )
-            return {}
-        async with _pending_task_duplicate_push_conditions[api_url]:
-            if current_active_tasks == 1:
-                # second task waits
-                get_logger().info(
-                    f"Waiting to process push trigger for {api_url=} because the first task is still in progress"
-                )
-                await _pending_task_duplicate_push_conditions[api_url].wait()
-                get_logger().info(f"Finished waiting to process push trigger for {api_url=} - continue with flow")
-
-        try:
-            if get_settings().github_app.push_trigger_wait_for_initial_review and not get_git_provider()(api_url, incremental=IncrementalPR(True)).previous_review:
-                get_logger().info(f"Skipping incremental review because there was no initial review for {api_url=} yet")
-                return {}
-            get_logger().info(f"Performing incremental review for {api_url=} because of {event=} and {action=}")
-            await _perform_commands("push_commands", agent, body, api_url, log_context)
-
-        finally:
-            # release the waiting task block
-            async with _pending_task_duplicate_push_conditions[api_url]:
-                _pending_task_duplicate_push_conditions[api_url].notify(1)
-                _duplicate_push_triggers[api_url] -= 1
-
-    get_logger().info("event or action does not require handling")
     return {}
 
 
-def _check_pull_request_event(action: str, body: dict, log_context: dict, bot_user: str) -> Tuple[Dict[str, Any], str]:
+def handle_line_comments(body: Dict, comment_body: [str, Any]) -> str:
+    if not comment_body:
+        return ""
+    start_line = body["comment"]["start_line"]
+    end_line = body["comment"]["line"]
+    start_line = end_line if not start_line else start_line
+    question = comment_body.replace('/ask', '').strip()
+    diff_hunk = body["comment"]["diff_hunk"]
+    get_settings().set("ask_diff_hunk", diff_hunk)
+    path = body["comment"]["path"]
+    side = body["comment"]["side"]
+    comment_id = body["comment"]["id"]
+    if '/ask' in comment_body:
+        comment_body = f"/ask_line --line_start={start_line} --line_end={end_line} --side={side} --file_name={path} --comment_id={comment_id} {question}"
+    return comment_body
+
+
+def _check_pull_request_event(action: str, body: dict, log_context: dict) -> Tuple[Dict[str, Any], str]:
     invalid_result = {}, ""
     pull_request = body.get("pull_request")
     if not pull_request:
@@ -195,7 +299,7 @@ def _check_pull_request_event(action: str, body: dict, log_context: dict, bot_us
     if not api_url:
         return invalid_result
     log_context["api_url"] = api_url
-    if pull_request.get("draft", True) or pull_request.get("state") != "open" or pull_request.get("user", {}).get("login", "") == bot_user:
+    if pull_request.get("draft", True) or pull_request.get("state") != "open":
         return invalid_result
     if action in ("review_requested", "synchronize") and pull_request.get("created_at") == pull_request.get("updated_at"):
         # avoid double reviews when opening a PR for the first time
@@ -203,51 +307,40 @@ def _check_pull_request_event(action: str, body: dict, log_context: dict, bot_us
     return pull_request, api_url
 
 
-async def _perform_commands(commands_conf: str, agent: PRAgent, body: dict, api_url: str, log_context: dict):
+async def _perform_auto_commands_github(commands_conf: str, agent: PRAgent, body: dict, api_url: str, log_context: dict):
     apply_repo_settings(api_url)
     commands = get_settings().get(f"github_app.{commands_conf}")
+    if not commands:
+        with get_logger().contextualize(**log_context):
+            get_logger().info(f"New PR, but no auto commands configured")
+        return
     for command in commands:
         split_command = command.split(" ")
         command = split_command[0]
         args = split_command[1:]
         other_args = update_settings_from_args(args)
         new_command = ' '.join([command] + other_args)
-        get_logger().info(body)
-        get_logger().info(f"Performing command: {new_command}")
         with get_logger().contextualize(**log_context):
+            get_logger().info(f"{commands_conf}. Performing auto command '{new_command}', for {api_url=}")
             await agent.handle_request(api_url, new_command)
 
 
-def _is_duplicate_request(body: Dict[str, Any]) -> bool:
-    """
-    In some deployments its possible to get duplicate requests if the handling is long,
-    This function checks if the request is duplicate and if so - ignores it.
-    """
-    request_hash = hash(str(body))
-    get_logger().info(f"request_hash: {request_hash}")
-    is_duplicate = _duplicate_requests_cache.get(request_hash, False)
-    _duplicate_requests_cache[request_hash] = True
-    if is_duplicate:
-        get_logger().info(f"Ignoring duplicate request {request_hash}")
-    return is_duplicate
-
-
 @router.get("/")
 async def root():
     return {"status": "ok"}
 
 
+if get_settings().github_app.override_deployment_type:
+    # Override the deployment type to app
+    get_settings().set("GITHUB.DEPLOYMENT_TYPE", "app")
+get_settings().set("CONFIG.PUBLISH_OUTPUT_PROGRESS", False)
+middleware = [Middleware(RawContextMiddleware)]
+app = FastAPI(middleware=middleware)
+app.include_router(router)
+
+
 def start():
-    if get_settings().github_app.override_deployment_type:
-        # Override the deployment type to app
-        get_settings().set("GITHUB.DEPLOYMENT_TYPE", "app")
-    get_settings().set("CONFIG.PUBLISH_OUTPUT_PROGRESS", False)
-    middleware = [Middleware(RawContextMiddleware)]
-    app = FastAPI(middleware=middleware)
-    app.include_router(router)
-
     uvicorn.run(app, host="0.0.0.0", port=int(os.environ.get("PORT", "3000")))
 
-
 if __name__ == '__main__':
     start()

pr_agent/servers/github_polling.py

@@ -7,9 +7,8 @@ from pr_agent.agent.pr_agent import PRAgent
 from pr_agent.config_loader import get_settings
 from pr_agent.git_providers import get_git_provider
 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, level="DEBUG")
 NOTIFICATION_URL = "https://api.github.com/notifications"
 
 
@@ -104,8 +103,6 @@ async def polling_loop():
                                                                                  notify=lambda: git_provider.add_eyes_reaction(comment_id))  # noqa E501
                                             if not success:
                                                 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:
                         print(f"Failed to fetch notifications. Status code: {response.status}")

pr_agent/servers/gitlab_webhook.py

@@ -11,11 +11,13 @@ from starlette_context import context
 from starlette_context.middleware import RawContextMiddleware
 
 from pr_agent.agent.pr_agent import PRAgent
+from pr_agent.algo.utils import update_settings_from_args
 from pr_agent.config_loader import get_settings, global_settings
+from pr_agent.git_providers.utils import apply_repo_settings
 from pr_agent.log import LoggingFormat, get_logger, setup_logger
 from pr_agent.secret_providers import get_secret_provider
 
-setup_logger(fmt=LoggingFormat.JSON)
+setup_logger(fmt=LoggingFormat.JSON, level="DEBUG")
 router = APIRouter()
 
 secret_provider = get_secret_provider() if get_settings().get("CONFIG.SECRET_PROVIDER") else None
@@ -29,9 +31,29 @@ def handle_request(background_tasks: BackgroundTasks, url: str, body: str, log_c
         background_tasks.add_task(PRAgent().handle_request, url, body)
 
 
+async def _perform_commands_gitlab(commands_conf: str, agent: PRAgent, api_url: str, log_context: dict):
+    apply_repo_settings(api_url)
+    commands = get_settings().get(f"gitlab.{commands_conf}", {})
+    for command in commands:
+        try:
+            split_command = command.split(" ")
+            command = split_command[0]
+            args = split_command[1:]
+            other_args = update_settings_from_args(args)
+            new_command = ' '.join([command] + other_args)
+            get_logger().info(f"Performing command: {new_command}")
+            with get_logger().contextualize(**log_context):
+                await agent.handle_request(api_url, new_command)
+        except Exception as e:
+            get_logger().error(f"Failed to perform command {command}: {e}")
+
+
 @router.post("/webhook")
 async def gitlab_webhook(background_tasks: BackgroundTasks, request: Request):
     log_context = {"server_type": "gitlab_app"}
+    get_logger().debug("Received a GitLab webhook")
+
+    # Check if the request is authorized
     if request.headers.get("X-Gitlab-Token") and secret_provider:
         request_token = request.headers.get("X-Gitlab-Token")
         secret = secret_provider.get_secret(request_token)
@@ -47,27 +69,57 @@ async def gitlab_webhook(background_tasks: BackgroundTasks, request: Request):
     elif get_settings().get("GITLAB.SHARED_SECRET"):
         secret = get_settings().get("GITLAB.SHARED_SECRET")
         if not request.headers.get("X-Gitlab-Token") == secret:
+            get_logger().error(f"Failed to validate secret")
             return JSONResponse(status_code=status.HTTP_401_UNAUTHORIZED, content=jsonable_encoder({"message": "unauthorized"}))
     else:
+        get_logger().error(f"Failed to validate secret")
         return JSONResponse(status_code=status.HTTP_401_UNAUTHORIZED, content=jsonable_encoder({"message": "unauthorized"}))
     gitlab_token = get_settings().get("GITLAB.PERSONAL_ACCESS_TOKEN", None)
     if not gitlab_token:
+        get_logger().error(f"No gitlab token found")
         return JSONResponse(status_code=status.HTTP_401_UNAUTHORIZED, content=jsonable_encoder({"message": "unauthorized"}))
+
     data = await request.json()
-    get_logger().info(json.dumps(data))
+    get_logger().info("GitLab data", artifact=data)
+
     if data.get('object_kind') == 'merge_request' and data['object_attributes'].get('action') in ['open', 'reopen']:
-        get_logger().info(f"A merge request has been opened: {data['object_attributes'].get('title')}")
         url = data['object_attributes'].get('url')
-        handle_request(background_tasks, url, "/review", log_context)
+        get_logger().info(f"New merge request: {url}")
-    elif data.get('object_kind') == 'note' and data['event_type'] == 'note':
+        await _perform_commands_gitlab("pr_commands", PRAgent(), url, log_context)
+    elif data.get('object_kind') == 'note' and data['event_type'] == 'note': # comment on MR
         if 'merge_request' in data:
             mr = data['merge_request']
             url = mr.get('url')
+            get_logger().info(f"A comment has been added to a merge request: {url}")
             body = data.get('object_attributes', {}).get('note')
+            if data.get('object_attributes', {}).get('type') == 'DiffNote' and '/ask' in body: # /ask_line
+                body = handle_ask_line(body, data)
+
             handle_request(background_tasks, url, body, log_context)
+
     return JSONResponse(status_code=status.HTTP_200_OK, content=jsonable_encoder({"message": "success"}))
 
 
+def handle_ask_line(body, data):
+    try:
+        line_range_ = data['object_attributes']['position']['line_range']
+        # if line_range_['start']['type'] == 'new':
+        start_line = line_range_['start']['new_line']
+        end_line = line_range_['end']['new_line']
+        # else:
+        #     start_line = line_range_['start']['old_line']
+        #     end_line = line_range_['end']['old_line']
+        question = body.replace('/ask', '').strip()
+        path = data['object_attributes']['position']['new_path']
+        side = 'RIGHT'  # if line_range_['start']['type'] == 'new' else 'LEFT'
+        comment_id = data['object_attributes']["discussion_id"]
+        get_logger().info(f"Handling line comment")
+        body = f"/ask_line --line_start={start_line} --line_end={end_line} --side={side} --file_name={path} --comment_id={comment_id} {question}"
+    except Exception as e:
+        get_logger().error(f"Failed to handle ask line comment: {e}")
+    return body
+
+
 @router.get("/")
 async def root():
     return {"status": "ok"}

pr_agent/servers/help.py

@@ -1,19 +1,354 @@
-commands_text = "> **/review**: Request a review of your Pull Request.   \n" \
+class HelpMessage:
-                "> **/describe**: Update the PR title and description based on the contents of the PR.   \n" \
+    @staticmethod
-                "> **/improve [--extended]**: Suggest code improvements. Extended mode provides a higher quality feedback.   \n" \
+    def get_general_commands_text():
-                "> **/ask \\<QUESTION\\>**: Ask a question about the PR.   \n" \
+       commands_text = "> - **/review**: Request a review of your Pull Request.   \n" \
-                "> **/update_changelog**: Update the changelog based on the PR's contents.   \n" \
+                "> - **/describe**: Update the PR title and description based on the contents of the PR.   \n" \
-                "> **/add_docs**: Generate docstring for new components introduced in the PR.   \n" \
+                "> - **/improve [--extended]**: Suggest code improvements. Extended mode provides a higher quality feedback.   \n" \
-                "> **/generate_labels**: Generate labels for the PR based on the PR's contents.   \n" \
+                "> - **/ask \\<QUESTION\\>**: Ask a question about the PR.   \n" \
-                "> see the [tools guide](https://github.com/Codium-ai/pr-agent/blob/main/docs/TOOLS_GUIDE.md) for more details.\n\n" \
+                "> - **/update_changelog**: Update the changelog based on the PR's contents.   \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" \
+                "> - **/add_docs** 💎: Generate docstring for new components introduced in the PR.   \n" \
-                ">For example: /review --pr_reviewer.extra_instructions=\"focus on the file: ...\"    \n" \
+                "> - **/generate_labels** 💎: Generate labels for the PR based on the PR's contents.   \n" \
-                ">To list the possible configuration parameters, add a **/config** comment.   \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" \
+                ">To list the possible configuration parameters, add a **/config** comment.   \n"
+       return commands_text
 
 
-def bot_help_text(user: str):
+    @staticmethod
-    return f"> Tag me in a comment '@{user}' and add one of the following commands:  \n" + commands_text
+    def get_general_bot_help_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 'possible issues' 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"
+
+        output += "<tr><td><details> <summary><strong> Auto-approve PRs</strong></summary><hr>\n\n"
+        output += '''\
+By invoking:
+```
+/review auto_approve
+```
+The tool will automatically approve the PR, and add a comment with the approval.
 
 
-actions_help_text = "> To invoke the PR-Agent, add a comment using one of the following commands:  \n" + \
+To ensure safety, the auto-approval feature is disabled by default. To enable auto-approval, you need to actively set in a pre-defined configuration file the following:
-                    commands_text
+```
+[pr_reviewer]
+enable_auto_approval = true
+```
+(this specific flag cannot be set with a command line argument, only in the configuration file, committed to the repository)
+
+
+You can also enable auto-approval only if the PR meets certain requirements, such as that the `estimated_review_effort` is equal or below a certain threshold, by adjusting the flag:
+```
+[pr_reviewer]
+maximal_review_effort = 5
+```
+'''
+        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
+
+
+
+    @staticmethod
+    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

pr_agent/settings/.secrets_template.toml

@@ -65,9 +65,25 @@ personal_access_token = ""
 # For Bitbucket personal/repository bearer token
 bearer_token = ""
 
+[bitbucket_server]
+# For Bitbucket Server bearer token
+auth_token = ""
+webhook_secret = ""
+
 # For Bitbucket app
 app_key = ""
 base_url = ""
 
 [litellm]
 LITELLM_TOKEN = "" # see https://docs.litellm.ai/docs/debugging/hosted_debugging for details and instructions on how to get a token
+
+[azure_devops]
+# For Azure devops personal access token
+org = ""
+pat = ""
+
+[azure_devops_server]
+# For Azure devops Server basic auth - configured in the webhook creation 
+# Optional, uncomment if you want to use Azure devops webhooks. Value assinged when you create the webhook
+# webhook_username = "<basic auth user>"
+# webhook_password = "<basic auth password>"

pr_agent/settings/configuration.toml

@@ -1,56 +1,70 @@
 [config]
-model="gpt-4" # "gpt-4-1106-preview"
+model="gpt-4" # "gpt-4-0125-preview"
+model_turbo="gpt-4-0125-preview"
 fallback_models=["gpt-3.5-turbo-16k"]
 git_provider="github"
 publish_output=true
 publish_output_progress=true
 verbosity_level=0 # 0,1,2
 use_extra_bad_extensions=false
+use_wiki_settings_file=true
 use_repo_settings_file=true
-ai_timeout=180
+use_global_settings_file=true
+ai_timeout=120 # 2minutes
 max_description_tokens = 500
 max_commits_tokens = 500
 max_model_tokens = 32000 # Limits the maximum number of tokens that can be used by any model, regardless of the model's default capabilities.
-patch_extra_lines = 3
+patch_extra_lines = 1
 secret_provider="google_cloud_storage"
 cli_mode=false
+ai_disclaimer_title=""  # Pro feature, title for a collapsible disclaimer to AI outputs
+ai_disclaimer=""  # Pro feature, full text for the AI disclaimer
 
 [pr_reviewer] # /review #
 # enable/disable features
 require_focused_review=false
 require_score_review=false
 require_tests_review=true
-require_security_review=true
 require_estimate_effort_to_review=true
+# soc2
+require_soc2_ticket=false
+soc2_ticket_prompt="Does the PR description include a link to ticket in a project management system (e.g., Jira, Asana, Trello, etc.) ?"
 # general options
 num_code_suggestions=4
 inline_code_comments = false
 ask_and_reflect=false
-automatic_review=true
+#automatic_review=true
-remove_previous_review_comment=false
 persistent_comment=true
 extra_instructions = ""
+final_update_message = true
 # review labels
 enable_review_labels_security=true
-enable_review_labels_effort=false
+enable_review_labels_effort=true
 # specific configurations for incremental review (/review -i)
 require_all_thresholds_for_incremental_review=false
 minimal_commits_for_incremental_review=0
 minimal_minutes_for_incremental_review=0
+enable_help_text=true # Determines whether to include help text in the PR review. Enabled by default.
+# auto approval
+enable_auto_approval=false
+maximal_review_effort=5
+
 
 [pr_description] # /describe #
 publish_labels=true
 publish_description_as_comment=false
-add_original_user_description=false
+add_original_user_description=true
-keep_original_user_title=false
+keep_original_user_title=true
 use_bullet_points=true
 extra_instructions = ""
 enable_pr_type=true
-enable_file_walkthrough=false
-enable_semantic_files_types=true
 final_update_message = true
-
+enable_help_text=false
-
+enable_help_comment=true
+## changes walkthrough section
+enable_semantic_files_types=true
+collapsible_file_list='adaptive' # true, false, 'adaptive'
+inline_file_summary=false # false, true, 'table'
 # markers
 use_description_markers=false
 include_generated_by_header=true
@@ -58,17 +72,23 @@ include_generated_by_header=true
 #custom_labels = ['Bug fix', 'Tests', 'Bug fix with tests', 'Enhancement', 'Documentation', 'Other']
 
 [pr_questions] # /ask #
+enable_help_text=true
+
 
 [pr_code_suggestions] # /improve #
+max_context_tokens=8000
 num_code_suggestions=4
-summarize = false
+summarize = true
 extra_instructions = ""
 rank_suggestions = false
+enable_help_text=true
 # params for '/improve --extended' mode
-num_code_suggestions_per_chunk=8
+auto_extended_mode=true
-rank_extended_suggestions = true
+num_code_suggestions_per_chunk=5
-max_number_of_calls = 5
+max_number_of_calls = 3
-final_clip_factor = 0.9
+parallel_calls = true
+rank_extended_suggestions = false
+final_clip_factor = 0.8
 
 [pr_add_docs] # /add_docs #
 extra_instructions = ""
@@ -78,6 +98,26 @@ docs_style = "Sphinx Style" # "Google Style with Args, Returns, Attributes...etc
 push_changelog_changes=false
 extra_instructions = ""
 
+[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
+
+
+[checks] # /checks (pro feature) #
+enable_auto_checks_feedback=true
+excluded_checks_list=["lint"] # list of checks to exclude, for example: ["check1", "check2"]
+persistent_comment=true
+enable_help_text=true
+
+[pr_help] # /help #
+
 [pr_config] # /config #
 
 [github]
@@ -85,25 +125,23 @@ extra_instructions = ""
 deployment_type = "user"
 ratelimit_retries = 5
 base_url = "https://api.github.com"
+publish_inline_comments_fallback_with_verification = true
+try_fix_invalid_inline_comments = true
 
-[github_action]
+[github_action_config]
 # 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_improve = true   # set as env var in .github/workflows/pr-agent.yaml
 
 [github_app]
 # these toggles allows running the github app from custom deployments
-bot_user = "github-actions[bot]"
 override_deployment_type = true
-# in some deployments it's possible to get duplicate requests if the handling is long,
-# these settings are used to avoid handling duplicate requests.
-duplicate_requests_cache = false
-duplicate_requests_cache_ttl = 60  # in seconds
 # settings for "pull_request" event
-handle_pr_actions = ['opened', 'reopened', 'ready_for_review', 'review_requested']
+handle_pr_actions = ['opened', 'reopened', 'ready_for_review']
 pr_commands = [
     "/describe --pr_description.add_original_user_description=true --pr_description.keep_original_user_title=true",
-    "/auto_review",
+    "/review --pr_reviewer.num_code_suggestions=0",
+    "/improve --pr_code_suggestions.summarize=true",
 ]
 # settings for "pull_request" event with "synchronize" action - used to detect and handle push triggers for new commits
 handle_push_trigger = false
@@ -114,34 +152,24 @@ push_trigger_pending_tasks_backlog = true
 push_trigger_pending_tasks_ttl = 300
 push_commands = [
     "/describe --pr_description.add_original_user_description=true --pr_description.keep_original_user_title=true",
-    """/auto_review -i \
+    "/review --pr_reviewer.num_code_suggestions=0",
-       --pr_reviewer.require_focused_review=false \
-       --pr_reviewer.require_score_review=false \
-       --pr_reviewer.require_tests_review=false \
-       --pr_reviewer.require_security_review=false \
-       --pr_reviewer.require_estimate_effort_to_review=false \
-       --pr_reviewer.num_code_suggestions=0 \
-       --pr_reviewer.inline_code_comments=false \
-       --pr_reviewer.remove_previous_review_comment=true \
-       --pr_reviewer.require_all_thresholds_for_incremental_review=false \
-       --pr_reviewer.minimal_commits_for_incremental_review=5 \
-       --pr_reviewer.minimal_minutes_for_incremental_review=30 \
-       --pr_reviewer.extra_instructions='' \
-    """
 ]
+ignore_pr_title = []
 
 [gitlab]
-# URL to the gitlab service
+url = "https://gitlab.com" # URL to the gitlab service
-url = "https://gitlab.com"
+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",
+]
 
-# Polling (either project id or namespace/project_name) syntax can be used
+[bitbucket_app]
-projects_to_monitor = ['org_name/repo_name']
+pr_commands = [
+    "/review --pr_reviewer.num_code_suggestions=0",
+    "/improve --pr_code_suggestions.summarize=false",
+]
 
-# Polling trigger
-magic_word = "AutoReview"
-
-# Polling interval
-polling_interval_seconds = 30
 
 [local]
 # LocalGitProvider settings - uncomment to use paths other than default
@@ -158,6 +186,11 @@ polling_interval_seconds = 30
 # token to authenticate in the patch server
 # patch_server_token = ""
 
+[bitbucket_server]
+# URL to the BitBucket Server instance
+# url = "https://git.bitbucket.com"
+url = ""
+
 [litellm]
 #use_client = false
 
@@ -165,8 +198,12 @@ polling_interval_seconds = 30
 skip_comments = false
 force_update_dataset = false
 max_issues_to_scan = 500
+vectordb = "pinecone"
 
 [pinecone]
 # fill and place in .secrets.toml
 #api_key = ...
 # environment = "gcp-starter"
+
+[lancedb]
+uri = "./lancedb"

pr_agent/settings/pr_add_docs.toml

@@ -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:
 ======
-## src/file1.py
+## file: 'src/file1.py'
 
 @@ -12,3 +12,4 @@ def func1():
 __new hunk__
@@ -18,7 +18,6 @@ __old hunk__
 -code line that was removed in the PR
  code line2 that remained unchanged in the PR
 
-
 @@ ... @@ def func2():
 __new hunk__
 ...
@@ -26,7 +25,7 @@ __old hunk__
 ...
 
 
-## src/file2.py
+## file: 'src/file2.py'
 ...
 ======
 
@@ -35,7 +34,7 @@ Specific instructions:
 - Try to identify edited/added code components (classes/functions/methods...) that are undocumented, and generate {{ docs_for_language }} for each one.
 - If there are documented (any type of {{ language }} documentation) code components in the PR, Don't generate {{ docs_for_language }} for them.
 - Ignore code components that don't appear fully in the '__new hunk__' section. For example, you must see the component header and body.
-- Make sure the {{ docs_for_language }} starts and ends with standart {{ language }} {{ docs_for_language }} signs.
+- Make sure the {{ docs_for_language }} starts and ends with standard {{ language }} {{ docs_for_language }} signs.
 - The {{ docs_for_language }} should be in standard format.
 - Provide the exact line number (inclusive) where the {{ docs_for_language }} should be added.
 
@@ -69,6 +68,7 @@ Code Documentation:
         - after
       description: |-
         The {{ docs_for_language }} placement relative to the relevant line (code component).
+        For example, in Python the docs are placed after the function signature, but in Java they are placed before.
     documentation:
       type: string
       description: |-

pr_agent/settings/pr_code_suggestions_prompts.toml

@@ -4,19 +4,17 @@ Your task is to provide meaningful and actionable code suggestions, to improve t
 
 Example for the PR Diff format:
 ======
-## src/file1.py
+## file: 'src/file1.py'
 
-@@ -12,3 +12,4 @@ def func1():
+@@ ... @@ def func1():
 __new hunk__
 12  code line1 that remained unchanged in the PR
-14 +new code line1 added in the PR
+13 +new hunk code line2 added in the PR
-15 +new code line2 added in the PR
+14  code line3 that remained unchanged in the PR
-16  code line2 that remained unchanged in the PR
 __old hunk__
  code line1 that remained unchanged in the PR
--code line that was removed in the PR
+-old hunk code line2 that was removed in the PR
- code line2 that remained unchanged in the PR
+ code line3 that remained unchanged in the PR
-
 
 @@ ... @@ def func2():
 __new hunk__
@@ -25,24 +23,24 @@ __old hunk__
 ...
 
 
-## src/file2.py
+## file: 'src/file2.py'
 ...
 ======
 
 
 Specific instructions:
-- Provide up to {{ num_code_suggestions }} code suggestions. Try to provide diverse and insightful suggestions.
+- Provide up to {{ num_code_suggestions }} code suggestions. The suggestions should be diverse and insightful.
-- Prioritize suggestions that address major problems, issues and bugs in the code. As a second priority, suggestions should focus on best practices, code readability, maintainability, enhancments, performance, and other aspects.
+- The suggestions should refer only to code from the '__new hunk__' sections, and focus on new lines of code (lines starting with '+').
-- Don't suggest to add docstring, type hints, or comments.
+- 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.
-- Suggestions should refer only to code from the '__new hunk__' sections, and focus on new lines of code (lines starting with '+').
+- Don't suggest to add docstring, type hints, or comments, or to remove unused imports.
-- 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.
+- Suggestions should not repeat code already present in the '__new hunk__' sections.
-- For each suggestion, make sure to take into consideration also the context, meaning the lines before and after the relevant code.
 - 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 (').
 
 
 {%- if extra_instructions %}
 
+
 Extra instructions from the user:
 ======
 {{ extra_instructions }}
@@ -50,85 +48,67 @@ Extra instructions from the user:
 {%- endif %}
 
 
-You must use the following YAML schema to format your answer:
+The output must be a YAML object equivalent to type $PRCodeSuggestions, according to the following Pydantic definitions:
-```yaml
+=====
-Code suggestions:
+class CodeSuggestion(BaseModel):
-  type: array
+    relevant_file: str = Field(description="the relevant file full path")
-  minItems: 1
+    language: str = Field(description="the code language of the relevant file")
-  maxItems: {{ num_code_suggestions }}
+    suggestion_content: str = Field(description="an actionable suggestion for meaningfully improving the new code introduced in the PR")
-  uniqueItems: true
+{%- if summarize_mode %}
-  items:
+    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.")
-    relevant file:
+    improved_code: str = Field(description="a short code snippet to illustrate the improved code, after applying the suggestion.")
-      type: string
+    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.")
-      description: the relevant file full path
+{%- else %}
-    suggestion content:
+    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")
-      type: string
+    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")
-      description: |-
+{%- endif %}
-        a concrete suggestion for meaningfully improving the new PR code.
+    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")
-    existing code:
+    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")
-      type: string
+    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")
-      description: |-
+
-        a code snippet showing the relevant code lines from a '__new hunk__' section.
+class PRCodeSuggestions(BaseModel):
-        It must be contiguous, correctly formatted and indented, and without line numbers.
+    code_suggestions: List[CodeSuggestion]
-    relevant lines start:
+=====
-      type: integer
+
-      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:
-      type: integer
-      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:
-      type: string
-      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.
-```
 
 Example output:
 ```yaml
-Code suggestions:
+code_suggestions:
-- relevant file: |-
+- relevant_file: |
     src/file1.py
-  suggestion content: |-
+  language: |
-    Add a docstring to func1()
+    python
-  existing code: |-
+  suggestion_content: |
-    def func1():
+    ...
-  relevant lines start: |-
+{%- if summarize_mode %}
-    12
+  existing_code: |
-  relevant lines end: |-
+    ...
-    12
+  improved_code: |
-  improved code: |-
+    ...
+  one_sentence_summary: |
+    ...
+  relevant_lines_start: 12
+  relevant_lines_end: 13
+{%- else %}
+  existing_code: |
+    ...
+  relevant_lines_start: 12
+  relevant_lines_end: 13
+  improved_code: |
+    ...
+{%- endif %}
+  label: |
     ...
-...
 ```
 
 
-Each YAML output MUST be after a newline, indented, with block scalar indicator ('|-').
+Each YAML output MUST be after a newline, indented, with block scalar indicator ('|').
-Don't repeat the prompt in the answer, and avoid outputting the 'type' and 'description' fields.
 """
 
 user="""PR Info:
 
 Title: '{{title}}'
 
-Branch: '{{branch}}'
-
-{%- if description %}
-
-Description:
-======
-{{ description|trim }}
-======
-{%- endif %}
-
-{%- if language %}
-
-Main PR language: '{{ language }}'
-{%- endif %}
-
 
 The PR Diff:
 ======

pr_agent/settings/pr_custom_labels.toml

@@ -30,7 +30,7 @@ class Label(str, Enum):
 {%- endif %}
 
 class Labels(BaseModel):
-    labels: List[Label] = Field(min_items=0, description="custom labels that describe the PR. Return the label value, not the name.")
+    labels: List[Label] =  Field(min_items=0, description="choose the relevant custom labels that describe the PR content, and return their keys. Use the value field of the Label object to better understand the label meaning.")
 ======
 
 

pr_agent/settings/pr_description_prompts.toml

@@ -1,16 +1,21 @@
 [pr_description_prompt]
 system="""You are PR-Reviewer, a language model designed to review a Git Pull Request (PR).
-Your task is to provide a full description for the PR content - title, type, description, and main files walkthrough.
+{%- if enable_custom_labels %}
+Your task is to provide a full description for the PR content - files walkthrough, title, type, description and labels.
+{%- else %}
+Your task is to provide a full description for the PR content - files walkthrough, title, type, and description.
+{%- endif %}
 - Focus on the new PR code (lines starting with '+').
 - Keep in mind that the 'Previous title', 'Previous description' and 'Commit messages' sections may be partial, simplistic, non-informative or out of date. Hence, compare them to the PR diff code, and use them only as a reference.
 - The generated title and description should prioritize the most significant changes.
 - If needed, each YAML output should be in block scalar indicator ('|-')
+- When quoting variables or names from the code, use backticks (`) instead of single quote (').
 
 {%- if extra_instructions %}
 
 Extra instructions from the user:
 =====
-{{ extra_instructions }}
+{{extra_instructions}}
 =====
 {% endif %}
 
@@ -30,31 +35,25 @@ class PRType(str, Enum):
 
 {%- endif %}
 
-{%- if enable_file_walkthrough %}
-class FileWalkthrough(BaseModel):
-    filename: str = Field(description="the relevant file full path")
-    changes_in_file: str = Field(description="minimal and concise summary of the changes in the relevant file")
-{%- endif %}
-
 {%- if enable_semantic_files_types %}
+
 Class FileDescription(BaseModel):
     filename: str = Field(description="the relevant file full path")
-    changes_summary: str = Field(description="minimal and concise summary of the changes in the relevant file")
+    language: str = Field(description="the relevant file language")
+    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', ...")
 {%- endif %}
 
 Class PRDescription(BaseModel):
-    title: str = Field(description="an informative title for the PR, describing its main theme")
+    type: List[PRType] = Field(description="one or more types that describe the PR content. Return the label member value (e.g. 'Bug fix', not 'bug_fix')")
-    type: List[PRType] = Field(description="one or more types that describe the PR type. Return the label value, not the name.")
-    description: str = Field(description="an informative and concise description of the PR. {%- if use_bullet_points %} Use bullet points.{% endif %}")
-{%- if enable_custom_labels %}
-    labels: List[Label] = Field(min_items=0, description="custom labels that describe the PR. Return the label value, not the name.")
-{%- endif %}
-{%- if enable_file_walkthrough %}
-    main_files_walkthrough: List[FileWalkthrough] = Field(max_items=10)
-{%- endif %}
 {%- if enable_semantic_files_types %}
-    pr_files[List[FileDescription]] = Field(max_items=15")
+    pr_files[List[FileDescription]] = Field(max_items=15, description="a list of the files in the PR, and their changes summary.")
+{%- endif %}
+    description: str = Field(description="an informative and concise description of the PR. Use bullet points. Display first the most significant changes.")
+    title: str = Field(description="an informative title for the PR, describing its main theme")
+{%- if enable_custom_labels %}
+    labels: List[Label] =  Field(min_items=0, description="choose the relevant custom labels that describe the PR content, and return their keys. Use the value field of the Label object to better understand the label meaning.")
 {%- endif %}
 =====
 
@@ -62,36 +61,37 @@ Class PRDescription(BaseModel):
 Example output:
 
 ```yaml
-title: |-
-  ...
 type:
 - ...
 - ...
-{%- if enable_custom_labels %}
-labels:
-- ...
-- ...
-{%- endif %}
-description: |-
-  ...
-{%- if enable_file_walkthrough %}
-main_files_walkthrough:
-- ...
-- ...
-{%- endif %}
 {%- if enable_semantic_files_types %}
 pr_files:
 - filename: |
     ...
+  language: |
+    ...
   changes_summary: |
     ...
+  changes_title: |
+    ...
   label: |
     ...
 ...
 {%- endif %}
+description: |-
+  ...
+title: |-
+  ...
+{%- if enable_custom_labels %}
+labels:
+- |
+  ...
+- |
+  ...
+{%- endif %}
 ```
 
-Answer should be a valid YAML, and nothing else. Each YAML output MUST be after a newline, with proper indent, and block scalar indicator ('|-')
+Answer should be a valid YAML, and nothing else. Each YAML output MUST be after a newline, with proper indent, and block scalar indicator ('|')
 """
 
 user="""PR Info:
@@ -107,10 +107,7 @@ Previous description:
 {%- endif %}
 
 Branch: '{{branch}}'
-{%- if language %}
 
-Main PR language: '{{ language }}'
-{%- endif %}
 {%- if commit_messages_str %}
 
 Commit messages:

pr_agent/settings/pr_line_questions_prompts.toml

@@ -0,0 +1,53 @@
+[pr_line_questions_prompt]
+system="""You are PR-Reviewer, a language model designed to answer questions about a Git Pull Request (PR).
+
+Your goal is to answer questions\\tasks about specific lines of code in the PR, and provide feedback.
+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.
+
+Additional guidelines:
+- When quoting variables or names from the code, use backticks (`) instead of single quote (').
+- If relevant, use bullet points.
+- Be short and to the point.
+
+Example Hunk Structure:
+======
+## file: 'src/file1.py'
+
+@@ -12,5 +12,5 @@ def func1():
+code line 1 that remained unchanged in the PR
+code line 2 that remained unchanged in the PR
+-code line that was removed in the PR
++code line added in the PR
+code line 3 that remained unchanged in the PR
+======
+
+"""
+
+user="""PR Info:
+
+Title: '{{title}}'
+
+Branch: '{{branch}}'
+
+
+Here is a context hunk from the PR diff:
+======
+{{ full_hunk|trim }}
+======
+
+
+Now focus on the selected lines from the hunk:
+======
+{{ selected_lines|trim }}
+======
+Note that lines in the diff body are prefixed with a symbol that represents the type of change: '-' for deletions, '+' for additions, and ' ' (a space) for unchanged lines
+
+
+A question about the selected lines:
+======
+{{ question|trim }}
+======
+
+Response to the question:
+"""

pr_agent/settings/pr_questions_prompts.toml

@@ -1,7 +1,7 @@
 [pr_questions_prompt]
-system="""You are PR-Reviewer, a language model designed to review a Git Pull Request (PR).
+system="""You are PR-Reviewer, a language model designed to answer questions about a Git Pull Request (PR).
 
-Your goal is to answer questions\\tasks about the new PR code (lines starting with '+'), and provide feedback.
+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.
 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.
 """

pr_agent/settings/pr_reviewer_prompts.toml

@@ -1,11 +1,15 @@
 [pr_review_prompt]
 system="""You are PR-Reviewer, a language model designed to review a Git Pull Request (PR).
+{%- if num_code_suggestions > 0 %}
 Your task is to provide constructive and concise feedback for the PR, and also provide meaningful code suggestions.
+{%- else %}
+Your task is to provide constructive and concise feedback for the PR.
+{%- endif %}
 The review should focus on new code added in the PR diff (lines starting with '+')
 
 Example PR Diff:
 ======
-## src/file1.py
+## file: 'src/file1.py'
 
 @@ -12,5 +12,5 @@ def func1():
 code line 1 that remained unchanged in the PR
@@ -14,12 +18,11 @@ code line 2 that remained unchanged in the PR
 +code line added in the PR
 code line 3 that remained unchanged in the PR
 
-
 @@ ... @@ def func2():
 ...
 
 
-## src/file2.py
+## file: 'src/file2.py'
 ...
 ======
 
@@ -28,10 +31,11 @@ code line 3 that remained unchanged in the PR
 
 Code suggestions guidelines:
 - Provide up to {{ num_code_suggestions }} code suggestions. Try to provide diverse and insightful suggestions.
-- Focus on important suggestions like fixing code problems, issues and bugs. As a second priority, provide suggestions for meaningful code improvements, like performance, vulnerability, modularity, and best practices.
+- Focus on important suggestions like fixing code problems, issues and bugs. As a second priority, provide suggestions for meaningful code improvements like performance, vulnerability, modularity, and best practices.
 - 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 PR code.
 - Don't suggest to add docstring, type hints, or comments.
 - Suggestions should focus on the new code added in the PR diff (lines starting with '+')
+- When quoting variables or names from the code, use backticks (`) instead of single quote (').
 {%- endif %}
 
 {%- if extra_instructions %}
@@ -43,141 +47,81 @@ Extra instructions from the user:
 {% endif %}
 
 
-You must use the following YAML schema to format your answer:
+The output must be a YAML object equivalent to type $PRReview, according to the following Pydantic definitions:
-```yaml
+=====
-PR Analysis:
+class Review(BaseModel):
-  Main theme:
+{%- if require_estimate_effort_to_review %}
-    type: string
+    estimated_effort_to_review_[1-5]: str = Field(description="Estimate, on a scale of 1-5 (inclusive), the time and effort required to review this PR by an experienced and knowledgeable developer. 1 means short and easy review , 5 means long and hard review. Take into account the size, complexity, quality, and the needed changes of the PR code diff. Explain your answer in a short and concise manner.")
-    description: a short explanation of the PR
+{%- endif %}
-  PR summary:
-    type: string
-    description: summary of the PR in 2-3 sentences.
-  Type of PR:
-    type: string
-    enum:
-      - Bug fix
-      - Tests
-      - Enhancement
-      - Documentation
-      - Other
 {%- if require_score %}
-  Score:
+    score: str = Field(description="Rate this PR on a scale of 0-100 (inclusive), where 0 means the worst possible PR code, and 100 means PR code of the highest quality, without any bugs or performance issues, that is ready to be merged immediately and run in production at scale.")
-    type: int
-    description: |-
-      Rate this PR on a scale of 0-100 (inclusive), where 0 means the worst
-      possible PR code, and 100 means PR code of the highest quality, without
-      any bugs or performance issues, that is ready to be merged immediately and
-      run in production at scale.
 {%- endif %}
 {%- if require_tests %}
-  Relevant tests added:
+    relevant_tests: str = Field(description="yes\\no question: does this PR have relevant tests added or updated ?")
-    type: string
-    description: yes\\no question: does this PR have relevant tests ?
 {%- endif %}
 {%- if question_str %}
-  Insights from user's answer:
+    insights_from_user_answers: str = Field(description="shortly summarize the insights you gained from the user's answers to the questions")
-    type: string
-    description: |-
-      shortly summarize the insights you gained from the user's answers to the questions
 {%- endif %}
 {%- if require_focused %}
-  Focused PR:
+    focused_pr: str = Field(description="Is this a focused PR, in the sense that all the PR code diff changes are united under a single focused theme ? If the theme is too broad, or the PR code diff changes are too scattered, then the PR is not focused. Explain your answer shortly.")
-    type: string
-    description: |-
-      Is this a focused PR, in the sense that all the PR code diff changes are
-      united under a single focused theme ? If the theme is too broad, or the PR
-      code diff changes are too scattered, then the PR is not focused. Explain
-      your answer shortly.
 {%- endif %}
-{%- if require_estimate_effort_to_review %}
+    possible_issues: str = Field(description="Does this PR code introduce clear issues, bugs, or major performance concerns? If there are no apparent issues, respond with 'No'. If there are any issues, describe them briefly. Use bullet points if more than one issue. Be specific, and provide examples if possible. Start each bullet point with a short specific header, such as: "- Possible Bug: ...", etc.")
-  Estimated effort to review [1-5]:
+    security_concerns: str = Field(description="does this PR code introduce possible vulnerabilities such as exposure of sensitive information (e.g., API keys, secrets, passwords), or security concerns like SQL injection, XSS, CSRF, and others ? Answer 'No' if there are no possible issues. If there are security concerns or issues, start your answer with a short header, such as: 'Sensitive information exposure: ...', 'SQL injection: ...' etc. Explain your answer. Be specific and give examples if possible")
-    type: string
-    description: >-
-      Estimate, on a scale of 1-5 (inclusive), the time and effort required to review this PR by an experienced and knowledgeable developer. 1 means short and easy review , 5 means long and hard review.
-      Take into account the size, complexity, quality, and the needed changes of the PR code diff.
-      Explain your answer shortly (1-2 sentences). Use the format: '1, because ...'
-{%- endif %}
-PR Feedback:
-  General suggestions:
-    type: string
-    description: |-
-      General suggestions and feedback for the contributors and maintainers of this PR.
-      May include important suggestions for the overall structure,
-      primary purpose, best practices, critical bugs, and other aspects of the PR.
-      Don't address PR title and description, or lack of tests. Explain your suggestions.
 {%- if num_code_suggestions > 0 %}
-  Code feedback:
+
-    type: array
+class CodeSuggestion(BaseModel):
-    maxItems: {{ num_code_suggestions }}
+    relevant_file: str = Field(description="the relevant file full path")
-    uniqueItems: true
+    language: str = Field(description="the language of the relevant file")
-    items:
+    suggestion: str = Field(description="a concrete suggestion for meaningfully improving the new PR code. Also describe how, specifically, the suggestion can be applied to new PR code. Add tags with importance measure that matches each suggestion ('important' or 'medium'). Do not make suggestions for updating or adding docstrings, renaming PR title and description, or linter like.")
-      relevant file:
+    relevant_line: str = Field(description="a single code line taken from the relevant file, to which the suggestion applies. The code line should start with a '+'. Make sure to output the line exactly as it appears in the relevant file")
-        type: string
-        description: the relevant file full path
-      suggestion:
-        type: string
-        description: |-
-          a concrete suggestion for meaningfully improving the new PR code.
-          Also describe how, specifically, the suggestion can be applied to new PR code.
-          Add tags with importance measure that matches each suggestion ('important' or 'medium').
-          Do not make suggestions for updating or adding docstrings, renaming PR title and description, or linter like.
-      relevant line:
-        type: string
-        description: |-
-          a single code line taken from the relevant file, to which the suggestion applies.
-          The code line should start with a '+'.
-          Make sure to output the line exactly as it appears in the relevant file
 {%- endif %}
-{%- if require_security %}
+{%- if num_code_suggestions > 0 %}
-  Security concerns:
+
-    type: string
+class PRReview(BaseModel):
-    description: >-
+    review: Review
-      does this PR code introduce possible vulnerabilities such as exposure of sensitive information (e.g., API keys, secrets, passwords), or security concerns like SQL injection, XSS, CSRF, and others ? Answer 'No' if there are no possible issues.
+    code_feedback: List[CodeSuggestion]
-      Answer 'Yes, because ...' if there are security concerns or issues. Explain your answer shortly.
+{%- else %}
+
+class PRReview(BaseModel):
+    review: Review
 {%- endif %}
-```
+=====
+
 
 Example output:
 ```yaml
-PR Analysis:
+review:
-  Main theme: |-
-    xxx
-  PR summary: |-
-    xxx
-  Type of PR: |-
-    ...
-{%- if require_score %}
-  Score: 89
-{%- endif %}
-  Relevant tests added: |-
-    No
-{%- if require_focused %}
-  Focused PR: no, because ...
-{%- endif %}
 {%- if require_estimate_effort_to_review %}
-  Estimated effort to review [1-5]: |-
+  estimated_effort_to_review_[1-5]: |
     3, because ...
 {%- endif %}
-PR Feedback:
+{%- if require_score %}
-  General PR suggestions: |-
+  score: 89
-    ...
-{%- if num_code_suggestions > 0 %}
-  Code feedback:
-    - relevant file: |-
-        directory/xxx.py
-      suggestion: |-
-        xxx [important]
-      relevant line: |-
-        xxx
-    ...
 {%- endif %}
-{%- if require_security %}
+  relevant_tests: |
-  Security concerns: No
+    No
+{%- if require_focused %}
+  focused_pr: |
+    no, because ...
+{%- endif %}
+  possible_issues: |
+    No
+  security_concerns: |
+    No
+{%- if num_code_suggestions > 0 %}
+code_feedback
+- relevant_file: |
+    directory/xxx.py
+  language: |
+    python
+  suggestion: |
+    xxx [important]
+  relevant_line: |
+    xxx
 {%- endif %}
 ```
 
-Each YAML output MUST be after a newline, indented, with block scalar indicator ('|-').
+Answer should be a valid YAML, and nothing else. Each YAML output MUST be after a newline, with proper indent, and block scalar indicator ('|')
-Don't repeat the prompt in the answer, and avoid outputting the 'type' and 'description' fields.
 """
 
 user="""PR Info:
@@ -194,19 +138,8 @@ Description:
 ======
 {%- endif %}
 
-{%- if language %}
-
-Main PR language: '{{ language }}'
-{%- endif %}
-{%- if commit_messages_str %}
-
-Commit messages:
-======
-{{commit_messages_str}}
-======
-{%- endif %}
-
 {%- if question_str %}
+
 =====
 Here are questions to better understand the PR. Use the answers to provide better feedback.
 

pr_agent/tools/pr_add_docs.py

@@ -1,10 +1,12 @@
 import copy
 import textwrap
+from functools import partial
 from typing import Dict
 
 from jinja2 import Environment, StrictUndefined
 
-from pr_agent.algo.ai_handler import AiHandler
+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.pr_processing import get_pr_diff, retry_with_fallback_models
 from pr_agent.algo.token_handler import TokenHandler
 from pr_agent.algo.utils import load_yaml
@@ -15,14 +17,15 @@ from pr_agent.log import get_logger
 
 
 class PRAddDocs:
-    def __init__(self, pr_url: str, cli_mode=False, args: list = None):
+    def __init__(self, pr_url: str, cli_mode=False, args: list = None,
+                 ai_handler: partial[BaseAiHandler,] = LiteLLMAIHandler):
 
         self.git_provider = get_git_provider()(pr_url)
         self.main_language = get_main_pr_language(
             self.git_provider.get_languages(), self.git_provider.get_files()
         )
 
-        self.ai_handler = AiHandler()
+        self.ai_handler = ai_handler()
         self.patches_diff = None
         self.prediction = None
         self.cli_mode = cli_mode

pr_agent/tools/pr_code_suggestions.py

@@ -1,29 +1,43 @@
+import asyncio
 import copy
 import textwrap
+from functools import partial
 from typing import Dict, List
 from jinja2 import Environment, StrictUndefined
 
-from pr_agent.algo.ai_handler import AiHandler
+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.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.utils import load_yaml
+from pr_agent.algo.utils import load_yaml, replace_code_tags, ModelType
 from pr_agent.config_loader import get_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.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:
-    def __init__(self, pr_url: str, cli_mode=False, args: list = None):
+    def __init__(self, pr_url: str, cli_mode=False, args: list = None,
+                 ai_handler: partial[BaseAiHandler,] = LiteLLMAIHandler):
 
         self.git_provider = get_git_provider()(pr_url)
         self.main_language = get_main_pr_language(
             self.git_provider.get_languages(), self.git_provider.get_files()
         )
 
+        # limit context specifically for the improve command, which has hard input to parse:
+        if get_settings().pr_code_suggestions.max_context_tokens:
+            MAX_CONTEXT_TOKENS_IMPROVE = get_settings().pr_code_suggestions.max_context_tokens
+            if get_settings().config.max_model_tokens > MAX_CONTEXT_TOKENS_IMPROVE:
+                get_logger().info(f"Setting max_model_tokens to {MAX_CONTEXT_TOKENS_IMPROVE} for PR improve")
+                get_settings().config.max_model_tokens = MAX_CONTEXT_TOKENS_IMPROVE
+
+
         # extended mode
         try:
-            self.is_extended = any(["extended" in arg for arg in args])
+            self.is_extended = self._get_is_extended(args or [])
         except:
             self.is_extended = False
         if self.is_extended:
@@ -31,7 +45,7 @@ class PRCodeSuggestions:
         else:
             num_code_suggestions = get_settings().pr_code_suggestions.num_code_suggestions
 
-        self.ai_handler = AiHandler()
+        self.ai_handler = ai_handler()
         self.patches_diff = None
         self.prediction = None
         self.cli_mode = cli_mode
@@ -42,6 +56,7 @@ class PRCodeSuggestions:
             "language": self.main_language,
             "diff": "",  # empty diff for initial calculation
             "num_code_suggestions": num_code_suggestions,
+            "summarize_mode": get_settings().pr_code_suggestions.summarize,
             "extra_instructions": get_settings().pr_code_suggestions.extra_instructions,
             "commit_messages_str": self.git_provider.get_commit_messages(),
         }
@@ -50,98 +65,175 @@ class PRCodeSuggestions:
                                           get_settings().pr_code_suggestions_prompt.system,
                                           get_settings().pr_code_suggestions_prompt.user)
 
+        self.progress = f"## Generating PR code suggestions\n\n"
+        self.progress += f"""\nWork in progress ...<br>\n<img src="https://codium.ai/images/pr_agent/dual_ball_loading-crop.gif" width=48>"""
+        self.progress_response = None
+
     async def run(self):
         try:
             get_logger().info('Generating code suggestions for PR...')
+            relevant_configs = {'pr_code_suggestions': dict(get_settings().pr_code_suggestions),
+                                'config': dict(get_settings().config)}
+            get_logger().debug("Relevant configs", artifacts=relevant_configs)
             if get_settings().config.publish_output:
-                self.git_provider.publish_comment("Preparing suggestions...", is_temporary=True)
+                if self.git_provider.is_supported("gfm_markdown"):
+                    self.progress_response = self.git_provider.publish_comment(self.progress)
+                else:
+                    self.git_provider.publish_comment("Preparing suggestions...", is_temporary=True)
 
-            get_logger().info('Preparing PR code suggestions...')
             if not self.is_extended:
-                await retry_with_fallback_models(self._prepare_prediction)
+                await retry_with_fallback_models(self._prepare_prediction, ModelType.TURBO)
                 data = self._prepare_pr_code_suggestions()
             else:
-                data = await retry_with_fallback_models(self._prepare_prediction_extended)
+                data = await retry_with_fallback_models(self._prepare_prediction_extended, ModelType.TURBO)
-            if (not data) or (not 'Code suggestions' in data):
+
-                get_logger().info('No code suggestions found for PR.')
+            if (not data) or (not 'code_suggestions' in data) or (not data['code_suggestions']):
+                get_logger().error('No code suggestions found for PR.')
+                pr_body = "## PR Code Suggestions\n\nNo code suggestions found for PR."
+                get_logger().debug(f"PR output", artifact=pr_body)
+                if self.progress_response:
+                    self.git_provider.edit_comment(self.progress_response, body=pr_body)
+                else:
+                    self.git_provider.publish_comment(pr_body)
                 return
 
             if (not self.is_extended and get_settings().pr_code_suggestions.rank_suggestions) or \
                     (self.is_extended and get_settings().pr_code_suggestions.rank_extended_suggestions):
                 get_logger().info('Ranking Suggestions...')
-                data['Code suggestions'] = await self.rank_suggestions(data['Code suggestions'])
+                data['code_suggestions'] = await self.rank_suggestions(data['code_suggestions'])
 
             if get_settings().config.publish_output:
-                get_logger().info('Pushing PR code suggestions...')
                 self.git_provider.remove_initial_comment()
-                if get_settings().pr_code_suggestions.summarize:
+                if get_settings().pr_code_suggestions.summarize and self.git_provider.is_supported("gfm_markdown"):
-                    get_logger().info('Pushing summarize code suggestions...')
+
-                    self.publish_summarizes_suggestions(data)
+                    # generate summarized suggestions
+                    pr_body = self.generate_summarized_suggestions(data)
+                    get_logger().debug(f"PR output", artifact=pr_body)
+
+                    # add usage guide
+                    if get_settings().pr_code_suggestions.enable_help_text:
+                        pr_body += "<hr>\n\n<details> <summary><strong>✨ Improve tool usage guide:</strong></summary><hr> \n\n"
+                        pr_body += HelpMessage.get_improve_usage_guide()
+                        pr_body += "\n</details>\n"
+
+                    if self.progress_response:
+                        self.git_provider.edit_comment(self.progress_response, body=pr_body)
+                    else:
+                        self.git_provider.publish_comment(pr_body)
+
                 else:
-                    get_logger().info('Pushing inline code suggestions...')
                     self.push_inline_code_suggestions(data)
+                    if self.progress_response:
+                        self.progress_response.delete()
         except Exception as e:
             get_logger().error(f"Failed to generate code suggestions for PR, error: {e}")
+            if self.progress_response:
+                self.progress_response.delete()
+            else:
+                try:
+                    self.git_provider.remove_initial_comment()
+                    self.git_provider.publish_comment(f"Failed to generate code suggestions for PR")
+                except Exception as e:
+                    pass
 
     async def _prepare_prediction(self, model: str):
-        get_logger().info('Getting PR diff...')
         self.patches_diff = get_pr_diff(self.git_provider,
                                         self.token_handler,
                                         model,
                                         add_line_numbers_to_hunks=True,
                                         disable_extra_lines=True)
 
-        get_logger().info('Getting AI prediction...')
+        if self.patches_diff:
-        self.prediction = await self._get_prediction(model)
+            get_logger().debug(f"PR diff", artifact=self.patches_diff)
+            self.prediction = await self._get_prediction(model, self.patches_diff)
+        else:
+            get_logger().error(f"Error getting PR diff")
+            self.prediction = None
 
-    async def _get_prediction(self, model: str):
+    async def _get_prediction(self, model: str, patches_diff: str):
         variables = copy.deepcopy(self.vars)
-        variables["diff"] = self.patches_diff  # update diff
+        variables["diff"] = patches_diff  # update diff
         environment = Environment(undefined=StrictUndefined)
         system_prompt = environment.from_string(get_settings().pr_code_suggestions_prompt.system).render(variables)
         user_prompt = environment.from_string(get_settings().pr_code_suggestions_prompt.user).render(variables)
-        if get_settings().config.verbosity_level >= 2:
-            get_logger().info(f"\nSystem prompt:\n{system_prompt}")
-            get_logger().info(f"\nUser prompt:\n{user_prompt}")
         response, finish_reason = await self.ai_handler.chat_completion(model=model, temperature=0.2,
                                                                         system=system_prompt, user=user_prompt)
 
         return response
 
+    @staticmethod
+    def _truncate_if_needed(suggestion):
+        max_code_suggestion_length = get_settings().get("PR_CODE_SUGGESTIONS.MAX_CODE_SUGGESTION_LENGTH", 0)
+        suggestion_truncation_message = get_settings().get("PR_CODE_SUGGESTIONS.SUGGESTION_TRUNCATION_MESSAGE", "")
+        if max_code_suggestion_length > 0:
+            if len(suggestion['improved_code']) > max_code_suggestion_length:
+                suggestion['improved_code'] = suggestion['improved_code'][:max_code_suggestion_length]
+                suggestion['improved_code'] += f"\n{suggestion_truncation_message}"
+                get_logger().info(f"Truncated suggestion from {len(suggestion['improved_code'])} "
+                                      f"characters to {max_code_suggestion_length} characters")
+        return suggestion
+
     def _prepare_pr_code_suggestions(self) -> Dict:
         review = self.prediction.strip()
-        data = load_yaml(review)
+        data = load_yaml(review,
+                         keys_fix_yaml=["relevant_file", "suggestion_content", "existing_code", "improved_code"])
         if isinstance(data, list):
-            data = {'Code suggestions': data}
+            data = {'code_suggestions': data}
+
+        # remove invalid suggestions
+        suggestion_list = []
+        one_sentence_summary_list = []
+        for i, suggestion in enumerate(data['code_suggestions']):
+            if get_settings().pr_code_suggestions.summarize:
+                if not suggestion or 'one_sentence_summary' not in suggestion or 'label' not in suggestion or 'relevant_file' not in suggestion:
+                    get_logger().debug(f"Skipping suggestion {i + 1}, because it is invalid: {suggestion}")
+                    continue
+
+                if suggestion['one_sentence_summary'] in one_sentence_summary_list:
+                    get_logger().debug(f"Skipping suggestion {i + 1}, because it is a duplicate: {suggestion}")
+                    continue
+
+            if ('existing_code' in suggestion) and ('improved_code' in suggestion) and (
+                    suggestion['existing_code'] != suggestion['improved_code']):
+                suggestion = self._truncate_if_needed(suggestion)
+                if get_settings().pr_code_suggestions.summarize:
+                    one_sentence_summary_list.append(suggestion['one_sentence_summary'])
+                suggestion_list.append(suggestion)
+            else:
+                get_logger().debug(
+                    f"Skipping suggestion {i + 1}, because existing code is equal to improved code {suggestion['existing_code']}")
+        data['code_suggestions'] = suggestion_list
+
         return data
 
     def push_inline_code_suggestions(self, data):
         code_suggestions = []
 
-        if not data['Code suggestions']:
+        if not data['code_suggestions']:
             get_logger().info('No suggestions found to improve this PR.')
-            return self.git_provider.publish_comment('No suggestions found to improve this PR.')
+            if self.progress_response:
+                return self.git_provider.edit_comment(self.progress_response, body='No suggestions found to improve this PR.')
+            else:
+                return self.git_provider.publish_comment('No suggestions found to improve this PR.')
 
-        for d in data['Code suggestions']:
+        for d in data['code_suggestions']:
             try:
-                if get_settings().config.verbosity_level >= 2:
+                relevant_file = d['relevant_file'].strip()
-                    get_logger().info(f"suggestion: {d}")
+                relevant_lines_start = int(d['relevant_lines_start'])  # absolute position
-                relevant_file = d['relevant file'].strip()
+                relevant_lines_end = int(d['relevant_lines_end'])
-                relevant_lines_start = int(d['relevant lines start'])  # absolute position
+                content = d['suggestion_content'].rstrip()
-                relevant_lines_end = int(d['relevant lines end'])
+                new_code_snippet = d['improved_code'].rstrip()
-                content = d['suggestion content']
+                label = d['label'].strip()
-                new_code_snippet = d['improved code']
 
                 if new_code_snippet:
                     new_code_snippet = self.dedent_code(relevant_file, relevant_lines_start, new_code_snippet)
 
-                body = f"**Suggestion:** {content}\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,
-                                         'relevant_lines_start': relevant_lines_start,
+                                             'relevant_lines_start': relevant_lines_start,
-                                         'relevant_lines_end': relevant_lines_end})
+                                             'relevant_lines_end': relevant_lines_end})
             except Exception:
-                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}")
 
         is_successful = self.git_provider.publish_code_suggestions(code_suggestions)
         if not is_successful:
@@ -156,7 +248,8 @@ class PRCodeSuggestions:
             original_initial_line = None
             for file in self.diff_files:
                 if file.filename.strip() == relevant_file:
-                    original_initial_line = file.head_file.splitlines()[relevant_lines_start - 1]
+                    if file.head_file:  # in bitbucket, head_file is empty. toDo: fix this
+                        original_initial_line = file.head_file.splitlines()[relevant_lines_start - 1]
                     break
             if original_initial_line:
                 suggested_initial_line = new_code_snippet.splitlines()[0]
@@ -166,34 +259,49 @@ class PRCodeSuggestions:
                 if delta_spaces > 0:
                     new_code_snippet = textwrap.indent(new_code_snippet, delta_spaces * " ").rstrip('\n')
         except Exception as e:
-            if get_settings().config.verbosity_level >= 2:
+            get_logger().error(f"Could not dedent code snippet for file {relevant_file}, error: {e}")
-                get_logger().info(f"Could not dedent code snippet for file {relevant_file}, error: {e}")
 
         return new_code_snippet
 
+    def _get_is_extended(self, args: list[str]) -> bool:
+        """Check if extended mode should be enabled by the `--extended` flag or automatically according to the configuration"""
+        if any(["extended" in arg for arg in args]):
+            get_logger().info("Extended mode is enabled by the `--extended` flag")
+            return True
+        if get_settings().pr_code_suggestions.auto_extended_mode:
+            get_logger().info("Extended mode is enabled automatically based on the configuration toggle")
+            return True
+        return False
+
     async def _prepare_prediction_extended(self, model: str) -> dict:
-        get_logger().info('Getting PR diff...')
+        self.patches_diff_list = get_pr_multi_diffs(self.git_provider, self.token_handler, model,
-        patches_diff_list = get_pr_multi_diffs(self.git_provider, self.token_handler, model,
+                                                    max_calls=get_settings().pr_code_suggestions.max_number_of_calls)
-                                               max_calls=get_settings().pr_code_suggestions.max_number_of_calls)
+        if self.patches_diff_list:
+            get_logger().debug(f"PR diff", artifact=self.patches_diff_list)
 
-        get_logger().info('Getting multi AI predictions...')
+            # parallelize calls to AI:
-        prediction_list = []
+            if get_settings().pr_code_suggestions.parallel_calls:
-        for i, patches_diff in enumerate(patches_diff_list):
+                prediction_list = await asyncio.gather(
-            get_logger().info(f"Processing chunk {i + 1} of {len(patches_diff_list)}")
+                    *[self._get_prediction(model, patches_diff) for patches_diff in self.patches_diff_list])
-            self.patches_diff = patches_diff
+                self.prediction_list = prediction_list
-            prediction = await self._get_prediction(model)
-            prediction_list.append(prediction)
-        self.prediction_list = prediction_list
-
-        data = {}
-        for prediction in prediction_list:
-            self.prediction = prediction
-            data_per_chunk = self._prepare_pr_code_suggestions()
-            if "Code suggestions" in data:
-                data["Code suggestions"].extend(data_per_chunk["Code suggestions"])
             else:
-                data.update(data_per_chunk)
+                prediction_list = []
-        self.data = data
+                for i, patches_diff in enumerate(self.patches_diff_list):
+                    prediction = await self._get_prediction(model, patches_diff)
+                    prediction_list.append(prediction)
+
+            data = {}
+            for prediction in prediction_list:
+                self.prediction = prediction
+                data_per_chunk = self._prepare_pr_code_suggestions()
+                if "code_suggestions" in data:
+                    data["code_suggestions"].extend(data_per_chunk["code_suggestions"])
+                else:
+                    data.update(data_per_chunk)
+            self.data = data
+        else:
+            get_logger().error(f"Error getting PR diff")
+            self.data = data = None
         return data
 
     async def rank_suggestions(self, data: List) -> List:
@@ -208,13 +316,15 @@ class PRCodeSuggestions:
         """
 
         suggestion_list = []
-        # remove invalid suggestions
+        if not data:
-        for i, suggestion in enumerate(data):
+            return suggestion_list
-            if suggestion['existing code'] != suggestion['improved code']:
+        for suggestion in data:
-                suggestion_list.append(suggestion)
+            suggestion_list.append(suggestion)
-
         data_sorted = [[]] * len(suggestion_list)
 
+        if len(suggestion_list) == 1:
+            return suggestion_list
+
         try:
             suggestion_str = ""
             for i, suggestion in enumerate(suggestion_list):
@@ -226,9 +336,6 @@ class PRCodeSuggestions:
             system_prompt = environment.from_string(get_settings().pr_sort_code_suggestions_prompt.system).render(
                 variables)
             user_prompt = environment.from_string(get_settings().pr_sort_code_suggestions_prompt.user).render(variables)
-            if get_settings().config.verbosity_level >= 2:
-                get_logger().info(f"\nSystem prompt:\n{system_prompt}")
-                get_logger().info(f"\nUser prompt:\n{user_prompt}")
             response, finish_reason = await self.ai_handler.chat_completion(model=model, system=system_prompt,
                                                                             user=user_prompt)
 
@@ -239,8 +346,14 @@ class PRCodeSuggestions:
                 data_sorted[importance_order - 1] = suggestion_list[suggestion_number - 1]
 
             if get_settings().pr_code_suggestions.final_clip_factor != 1:
-                new_len = int(0.5 + len(data_sorted) * get_settings().pr_code_suggestions.final_clip_factor)
+                max_len = max(
-                data_sorted = data_sorted[:new_len]
+                    len(data_sorted),
+                    get_settings().pr_code_suggestions.num_code_suggestions,
+                    get_settings().pr_code_suggestions.num_code_suggestions_per_chunk,
+                )
+                new_len = int(0.5 + max_len * get_settings().pr_code_suggestions.final_clip_factor)
+                if new_len < len(data_sorted):
+                    data_sorted = data_sorted[:new_len]
         except Exception as e:
             if get_settings().config.verbosity_level >= 1:
                 get_logger().info(f"Could not sort suggestions, error: {e}")
@@ -248,9 +361,13 @@ class PRCodeSuggestions:
 
         return data_sorted
 
-    def publish_summarizes_suggestions(self, data: Dict):
+    def generate_summarized_suggestions(self, data: Dict) -> str:
         try:
-            data_markdown = "## PR Code Suggestions\n\n"
+            pr_body = "## 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
             extension_to_language = {}
@@ -258,31 +375,82 @@ class PRCodeSuggestions:
                 for ext in extensions:
                     extension_to_language[ext] = language
 
-            for s in data['Code suggestions']:
+            pr_body = "## PR Code Suggestions\n\n"
-                try:
+
-                    extension_s = s['relevant file'].rsplit('.')[-1]
+            pr_body += "<table>"
-                    code_snippet_link = self.git_provider.get_line_link(s['relevant file'], s['relevant lines start'],
+            header = f"Suggestions"
-                                                                        s['relevant lines end'])
+            delta = 76
-                    data_markdown += f"\n💡 Suggestion:\n\n**{s['suggestion content']}**\n\n"
+            header += "&nbsp; " * delta
-                    if code_snippet_link:
+            pr_body += f"""<thead><tr><td>Category</td><td align=left>{header}</td></tr></thead>"""
-                        data_markdown += f" File: [{s['relevant file']} ({s['relevant lines start']}-{s['relevant lines end']})]({code_snippet_link})\n\n"
+            pr_body += """<tbody>"""
+            suggestions_labels = dict()
+            # add all suggestions related to each label
+            for suggestion in data['code_suggestions']:
+                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():
+                num_suggestions=len(suggestions)
+                # pr_body += f"""<tr><td><strong>{label}</strong></td>"""
+                pr_body += f"""<tr><td rowspan={num_suggestions}><strong>{label.capitalize()}</strong></td>\n"""
+                # pr_body += f"""<td>"""
+                # pr_body += f"""<details><summary>{len(suggestions)} suggestions</summary>"""
+                # pr_body += f"""<table>"""
+                for i, suggestion in enumerate(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:
-                        data_markdown += f"File: {s['relevant file']} ({s['relevant lines start']}-{s['relevant lines end']})\n\n"
+                        range_str = f"[{relevant_lines_start}-{relevant_lines_end}]"
-                    if self.git_provider.is_supported("gfm_markdown"):
+                    code_snippet_link = self.git_provider.get_line_link(relevant_file, relevant_lines_start,
-                        data_markdown += "<details> <summary> Example code:</summary>\n\n"
+                                                                        relevant_lines_end)
-                        data_markdown += f"___\n\n"
+                    # add html table for each suggestion
-                    language_name = "python"
+
-                    if extension_s and (extension_s in extension_to_language):
+                    suggestion_content = suggestion['suggestion_content'].rstrip().rstrip()
-                        language_name = extension_to_language[extension_s]
+
-                    data_markdown += f"Existing code:\n```{language_name}\n{s['existing code']}\n```\n"
+                    suggestion_content = insert_br_after_x_chars(suggestion_content, 90)
-                    data_markdown += f"Improved code:\n```{language_name}\n{s['improved code']}\n```\n"
+                    # pr_body += f"<tr><td><details><summary>{suggestion_content}</summary>"
-                    if self.git_provider.is_supported("gfm_markdown"):
+                    existing_code = suggestion['existing_code'].rstrip()+"\n"
-                        data_markdown += "</details>\n"
+                    improved_code = suggestion['improved_code'].rstrip()+"\n"
-                    data_markdown += "\n___\n\n"
+
-                except Exception as e:
+                    diff = difflib.unified_diff(existing_code.split('\n'),
-                    get_logger().error(f"Could not parse suggestion: {s}, error: {e}")
+                                                improved_code.split('\n'), n=999)
-            self.git_provider.publish_comment(data_markdown)
+                    patch_orig = "\n".join(diff)
+                    patch = "\n".join(patch_orig.splitlines()[5:]).strip('\n')
+
+                    example_code = ""
+                    example_code += f"```diff\n{patch}\n```\n"
+                    if i==0:
+                        pr_body += f"""<td>\n\n"""
+                    else:
+                        pr_body += f"""<tr><td>\n\n"""
+                    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)*"&nbsp;"
+                    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 += "</details>"
+                pr_body += """</td></tr>"""
+            pr_body += """</tr></tbody></table>"""
+            return pr_body
         except Exception as e:
             get_logger().info(f"Failed to publish summarized code suggestions, error: {e}")
-
+            return ""
-

pr_agent/tools/pr_config.py

@@ -7,7 +7,7 @@ class PRConfig:
     """
     The PRConfig class is responsible for listing all configuration options available for the user.
     """
-    def __init__(self, pr_url: str, args=None):
+    def __init__(self, pr_url: str, args=None, ai_handler=None):
         """
         Initialize the PRConfig object with the necessary attributes and objects to comment on a pull request.
 

pr_agent/tools/pr_description.py

@@ -1,21 +1,25 @@
 import copy
 import re
+from functools import partial
 from typing import List, Tuple
 
 from jinja2 import Environment, StrictUndefined
 
-from pr_agent.algo.ai_handler import AiHandler
+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.pr_processing import get_pr_diff, retry_with_fallback_models
 from pr_agent.algo.token_handler import TokenHandler
-from pr_agent.algo.utils import load_yaml, set_custom_labels, get_user_labels
+from pr_agent.algo.utils import load_yaml, set_custom_labels, get_user_labels, ModelType
 from pr_agent.config_loader import get_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.log import get_logger
+from pr_agent.servers.help import HelpMessage
 
 
 class PRDescription:
-    def __init__(self, pr_url: str, args: list = None):
+    def __init__(self, pr_url: str, args: list = None,
+                 ai_handler: partial[BaseAiHandler,] = LiteLLMAIHandler):
         """
         Initialize the PRDescription object with the necessary attributes and objects for generating a PR description
         using an AI model.
@@ -32,11 +36,12 @@ class PRDescription:
 
         if get_settings().pr_description.enable_semantic_files_types and not self.git_provider.is_supported(
                 "gfm_markdown"):
-            get_logger().debug(f"Disabling semantic files types for {self.pr_id}")
+            get_logger().debug(f"Disabling semantic files types for {self.pr_id}, gfm_markdown not supported.")
             get_settings().pr_description.enable_semantic_files_types = False
 
         # Initialize the AI handler
-        self.ai_handler = AiHandler()
+        self.ai_handler = ai_handler()
+
     
         # Initialize the variables dictionary
         self.vars = {
@@ -45,17 +50,14 @@ class PRDescription:
             "description": self.git_provider.get_pr_description(full=False),
             "language": self.main_pr_language,
             "diff": "",  # empty diff for initial calculation
-            "use_bullet_points": get_settings().pr_description.use_bullet_points,
             "extra_instructions": get_settings().pr_description.extra_instructions,
             "commit_messages_str": self.git_provider.get_commit_messages(),
             "enable_custom_labels": get_settings().config.enable_custom_labels,
             "custom_labels_class": "",  # will be filled if necessary in 'set_custom_labels' function
-            "enable_file_walkthrough": get_settings().pr_description.enable_file_walkthrough,
             "enable_semantic_files_types": get_settings().pr_description.enable_semantic_files_types,
         }
-
         self.user_description = self.git_provider.get_user_description()
-    
+
         # Initialize the token handler
         self.token_handler = TokenHandler(
             self.git_provider.pr,
@@ -63,59 +65,79 @@ class PRDescription:
             get_settings().pr_description_prompt.system,
             get_settings().pr_description_prompt.user,
         )
-    
+
         # Initialize patches_diff and prediction attributes
         self.patches_diff = None
         self.prediction = None
+        self.file_label_dict = None
+        self.COLLAPSIBLE_FILE_LIST_THRESHOLD = 8
 
     async def run(self):
-        """
-        Generates a PR description using an AI model and publishes it to the PR.
-        """
-
         try:
-            get_logger().info(f"Generating a PR description {self.pr_id}")
+            get_logger().info(f"Generating a PR description for pr_id: {self.pr_id}")
+            relevant_configs = {'pr_description': dict(get_settings().pr_description),
+                                'config': dict(get_settings().config)}
+            get_logger().debug("Relevant configs", artifacts=relevant_configs)
             if get_settings().config.publish_output:
                 self.git_provider.publish_comment("Preparing PR description...", is_temporary=True)
 
-            await retry_with_fallback_models(self._prepare_prediction)
+            await retry_with_fallback_models(self._prepare_prediction, ModelType.TURBO) # turbo model because larger context
 
-            get_logger().info(f"Preparing answer {self.pr_id}")
             if self.prediction:
                 self._prepare_data()
             else:
+                get_logger().error(f"Error getting AI prediction {self.pr_id}")
+                self.git_provider.remove_initial_comment()
                 return None
 
             if get_settings().pr_description.enable_semantic_files_types:
-                self._prepare_file_labels()
+                self.file_label_dict = self._prepare_file_labels()
 
-            pr_labels = []
+            pr_labels, pr_file_changes = [], []
             if get_settings().pr_description.publish_labels:
                 pr_labels = self._prepare_labels()
 
             if get_settings().pr_description.use_description_markers:
-                pr_title, pr_body = self._prepare_pr_answer_with_markers()
+                pr_title, pr_body, changes_walkthrough, pr_file_changes = self._prepare_pr_answer_with_markers()
             else:
-                pr_title, pr_body,  = self._prepare_pr_answer()
+                pr_title, pr_body, changes_walkthrough, pr_file_changes = self._prepare_pr_answer()
-            full_markdown_description = f"## Title\n\n{pr_title}\n\n___\n{pr_body}"
+            if not self.git_provider.is_supported(
+                    "publish_file_comments") or not get_settings().pr_description.inline_file_summary:
+                pr_body += "\n\n" + changes_walkthrough
+            get_logger().debug("PR output", artifact={"title": pr_title, "body": pr_body})
+
+            # 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>✨ Describe tool usage guide:</strong></summary><hr> \n\n"
+                pr_body += HelpMessage.get_describe_usage_guide()
+                pr_body += "\n</details>\n"
+            elif get_settings().pr_description.enable_help_comment:
+                pr_body += "\n\n___\n\n> ✨ **PR-Agent usage**:"
+                pr_body += "\n>Comment `/help` on the PR to get a list of all available PR-Agent tools and their descriptions\n\n"
 
             if get_settings().config.publish_output:
-                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"):
+                    original_labels = self.git_provider.get_pr_labels()
+                    get_logger().debug(f"original labels", artifact=original_labels)
+                    user_labels = get_user_labels(original_labels)
+                    get_logger().debug(f"published labels:\n{pr_labels + user_labels}")
+                    self.git_provider.publish_labels(pr_labels + user_labels)
+
+                # publish description
                 if get_settings().pr_description.publish_description_as_comment:
+                    full_markdown_description = f"## Title\n\n{pr_title}\n\n___\n{pr_body}"
                     self.git_provider.publish_comment(full_markdown_description)
                 else:
                     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_labels()
-                        user_labels = get_user_labels(current_labels)
-                        self.git_provider.publish_labels(pr_labels + user_labels)
 
-                    if (get_settings().pr_description.final_update_message and
+                    # publish final update message
-                            hasattr(self.git_provider, 'pr_url') and self.git_provider.pr_url):
+                    if (get_settings().pr_description.final_update_message):
                         latest_commit_url = self.git_provider.get_latest_commit_url()
                         if latest_commit_url:
-                            self.git_provider.publish_comment(
+                            pr_url = self.git_provider.get_pr_url()
-                                f"**[PR Description]({self.git_provider.pr_url})** updated to latest commit ({latest_commit_url})")
+                            update_comment = f"**[PR Description]({pr_url})** updated to latest commit ({latest_commit_url})"
+                            self.git_provider.publish_comment(update_comment)
                 self.git_provider.remove_initial_comment()
         except Exception as e:
             get_logger().error(f"Error generating PR description {self.pr_id}: {e}")
@@ -123,26 +145,16 @@ class PRDescription:
         return ""
 
     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:
             return None
 
-        get_logger().info(f"Getting PR diff {self.pr_id}")
         self.patches_diff = get_pr_diff(self.git_provider, self.token_handler, model)
-        get_logger().info(f"Getting AI prediction {self.pr_id}")
+        if self.patches_diff:
-        self.prediction = await self._get_prediction(model)
+            get_logger().debug(f"PR diff", artifact=self.patches_diff)
+            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:
         """
@@ -158,14 +170,11 @@ class PRDescription:
         variables["diff"] = self.patches_diff  # update diff
 
         environment = Environment(undefined=StrictUndefined)
-        set_custom_labels(variables)
+        set_custom_labels(variables, self.git_provider)
+        self.variables = variables
         system_prompt = environment.from_string(get_settings().pr_description_prompt.system).render(variables)
         user_prompt = environment.from_string(get_settings().pr_description_prompt.user).render(variables)
 
-        if get_settings().config.verbosity_level >= 2:
-            get_logger().info(f"\nSystem prompt:\n{system_prompt}")
-            get_logger().info(f"\nUser prompt:\n{user_prompt}")
-
         response, finish_reason = await self.ai_handler.chat_completion(
             model=model,
             temperature=0.2,
@@ -173,9 +182,6 @@ class PRDescription:
             user=user_prompt
         )
 
-        if get_settings().config.verbosity_level >= 2:
-            get_logger().info(f"\nAI response:\n{response}")
-
         return response
 
     def _prepare_data(self):
@@ -185,6 +191,22 @@ class PRDescription:
         if get_settings().pr_description.add_original_user_description and self.user_description:
             self.data["User Description"] = self.user_description
 
+        # re-order keys
+        if 'User Description' in self.data:
+            self.data['User Description'] = self.data.pop('User Description')
+        if 'title' in self.data:
+            self.data['title'] = self.data.pop('title')
+        if 'type' in self.data:
+            self.data['type'] = self.data.pop('type')
+        if 'labels' in self.data:
+            self.data['labels'] = self.data.pop('labels')
+        if 'description' in self.data:
+            self.data['description'] = self.data.pop('description')
+        if 'pr_files' in self.data:
+            self.data['pr_files'] = self.data.pop('pr_files')
+
+
+
 
     def _prepare_labels(self) -> List[str]:
         pr_types = []
@@ -200,9 +222,19 @@ class PRDescription:
                 pr_types = self.data['type']
             elif type(self.data['type']) == str:
                 pr_types = self.data['type'].split(',')
+
+        # convert lowercase labels to original case
+        try:
+            if "labels_minimal_to_labels_dict" in self.variables:
+                d: dict = self.variables["labels_minimal_to_labels_dict"]
+                for i, label_i in enumerate(pr_types):
+                    if label_i in d:
+                        pr_types[i] = d[label_i]
+        except Exception as e:
+            get_logger().error(f"Error converting labels to original case {self.pr_id}: {e}")
         return pr_types
 
-    def _prepare_pr_answer_with_markers(self) -> Tuple[str, str]:
+    def _prepare_pr_answer_with_markers(self) -> Tuple[str, str, str, List[dict]]:
         get_logger().info(f"Using description marker replacements {self.pr_id}")
         title = self.vars["title"]
         body = self.user_description
@@ -221,20 +253,21 @@ class PRDescription:
             summary = f"{ai_header}{ai_summary}"
             body = body.replace('pr_agent:summary', summary)
 
-        if not re.search(r'<!--\s*pr_agent:walkthrough\s*-->', body):
+        ai_walkthrough = self.data.get('pr_files')
-            ai_walkthrough = self.data.get('PR Main Files Walkthrough')
+        walkthrough_gfm = ""
-            if ai_walkthrough:
+        pr_file_changes = []
-                walkthrough = str(ai_header)
+        if ai_walkthrough and not re.search(r'<!--\s*pr_agent:walkthrough\s*-->', body):
-                for file in ai_walkthrough:
+            try:
-                    filename = file['filename'].replace("'", "`")
+                walkthrough_gfm, pr_file_changes = self.process_pr_files_prediction(walkthrough_gfm,
-                    description = file['changes in file'].replace("'", "`")
+                                                                                    self.file_label_dict)
-                    walkthrough += f'- `{filename}`: {description}\n'
+                body = body.replace('pr_agent:walkthrough', walkthrough_gfm)
+            except Exception as e:
+                get_logger().error(f"Failing to process walkthrough {self.pr_id}: {e}")
+                body = body.replace('pr_agent:walkthrough', "")
 
-                body = body.replace('pr_agent:walkthrough', walkthrough)
+        return title, body, walkthrough_gfm, pr_file_changes
 
-        return title, body
+    def _prepare_pr_answer(self) -> Tuple[str, str, str, List[dict]]:
-
-    def _prepare_pr_answer(self) -> Tuple[str, str]:
         """
         Prepare the PR description based on the AI prediction data.
 
@@ -251,7 +284,7 @@ class PRDescription:
         if not get_settings().pr_description.enable_pr_type:
             self.data.pop('type')
         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"
 
         # Remove the 'PR Title' key from the dictionary
@@ -265,14 +298,14 @@ class PRDescription:
 
         # Iterate over the remaining dictionary items and append the key and value to 'pr_body' in a markdown format,
         # except for the items containing the word 'walkthrough'
-        pr_body = ""
+        pr_body, changes_walkthrough = "", ""
+        pr_file_changes = []
         for idx, (key, value) in enumerate(self.data.items()):
             if key == 'pr_files':
                 value = self.file_label_dict
-                key_publish = "PR changes walkthrough"
             else:
                 key_publish = key.rstrip(':').replace("_", " ").capitalize()
-            pr_body += f"## {key_publish}\n"
+                pr_body += f"## **{key_publish}**\n"
             if 'walkthrough' in key.lower():
                 if self.git_provider.is_supported("gfm_markdown"):
                     pr_body += "<details> <summary>files:</summary>\n\n"
@@ -283,64 +316,80 @@ class PRDescription:
                 if self.git_provider.is_supported("gfm_markdown"):
                     pr_body += "</details>\n"
             elif 'pr_files' in key.lower():
-                pr_body = self.process_pr_files_prediction(pr_body, value)
+                changes_walkthrough, pr_file_changes = self.process_pr_files_prediction(changes_walkthrough, value)
+                changes_walkthrough = f"## **Changes walkthrough**\n{changes_walkthrough}"
             else:
                 # if the value is a list, join its items by comma
                 if isinstance(value, list):
                     value = ', '.join(v for v in value)
                 pr_body += f"{value}\n"
             if idx < len(self.data) - 1:
-                pr_body += "\n___\n"
+                pr_body += "\n\n___\n\n"
 
-        if get_settings().config.verbosity_level >= 2:
+        return title, pr_body, changes_walkthrough, pr_file_changes,
-            get_logger().info(f"title:\n{title}\n{pr_body}")
-
-        return title, pr_body
 
     def _prepare_file_labels(self):
-        self.file_label_dict = {}
+        file_label_dict = {}
         for file in self.data['pr_files']:
             try:
                 filename = file['filename'].replace("'", "`").replace('"', '`')
                 changes_summary = file['changes_summary']
-                label = file['label']
+                changes_title = file['changes_title'].strip()
-                if label not in self.file_label_dict:
+                label = file.get('label')
-                    self.file_label_dict[label] = []
+                if label not in file_label_dict:
-                self.file_label_dict[label].append((filename, changes_summary))
+                    file_label_dict[label] = []
+                file_label_dict[label].append((filename, changes_title, changes_summary))
             except Exception as e:
                 get_logger().error(f"Error preparing file label dict {self.pr_id}: {e}")
                 pass
+        return file_label_dict
 
     def process_pr_files_prediction(self, pr_body, value):
-        if not self.git_provider.is_supported("gfm_markdown"):
+        pr_comments = []
-            get_logger().info(f"Disabling semantic files types for {self.pr_id} since gfm_markdown is not supported")
+        # logic for using collapsible file list
-            return pr_body
+        use_collapsible_file_list = get_settings().pr_description.collapsible_file_list
+        num_files = 0
+        if value:
+            for semantic_label in value.keys():
+                num_files += len(value[semantic_label])
+        if use_collapsible_file_list == "adaptive":
+            use_collapsible_file_list = num_files > self.COLLAPSIBLE_FILE_LIST_THRESHOLD
 
+        if not self.git_provider.is_supported("gfm_markdown"):
+            return pr_body
         try:
             pr_body += "<table>"
             header = f"Relevant files"
-            delta = 65
+            delta = 75
-            header += "&nbsp; " * delta
+            # header += "&nbsp; " * delta
-            pr_body += f"""<thead><tr><th></th><th>{header}</th></tr></thead>"""
+            pr_body += f"""<thead><tr><th></th><th align="left">{header}</th></tr></thead>"""
             pr_body += """<tbody>"""
             for semantic_label in value.keys():
                 s_label = semantic_label.strip("'").strip('"')
                 pr_body += f"""<tr><td><strong>{s_label.capitalize()}</strong></td>"""
                 list_tuples = value[semantic_label]
-                pr_body += f"""<td><details><summary>{len(list_tuples)} files</summary><table>"""
+
-                for filename, file_change_description in list_tuples:
+                if use_collapsible_file_list:
-                    filename = filename.replace("'", "`")
+                    pr_body += f"""<td><details><summary>{len(list_tuples)} files</summary><table>"""
+                else:
+                    pr_body += f"""<td><table>"""
+                for filename, file_changes_title, file_change_description in list_tuples:
+                    filename = filename.replace("'", "`").rstrip()
                     filename_publish = filename.split("/")[-1]
-                    filename_publish = f"{filename_publish}"
+                    file_changes_title_code = f"<code>{file_changes_title}</code>"
-                    if len(filename_publish) < (delta - 5):
+                    file_changes_title_code_br = insert_br_after_x_chars(file_changes_title_code, x=(delta - 5)).strip()
-                        filename_publish += "&nbsp; " * ((delta - 5) - len(filename_publish))
+                    if len(file_changes_title_code_br) < (delta - 5):
+                        file_changes_title_code_br += "&nbsp; " * ((delta - 5) - len(file_changes_title_code_br))
+                    filename_publish = f"<strong>{filename_publish}</strong><dd>{file_changes_title_code_br}</dd>"
                     diff_plus_minus = ""
+                    delta_nbsp = ""
                     diff_files = self.git_provider.diff_files
                     for f in diff_files:
                         if f.filename.lower() == filename.lower():
                             num_plus_lines = f.num_plus_lines
                             num_minus_lines = f.num_minus_lines
                             diff_plus_minus += f"+{num_plus_lines}/-{num_minus_lines}"
+                            delta_nbsp = "&nbsp; " * max(0, (8 - len(diff_plus_minus)))
                             break
 
                     # try to add line numbers link to code suggestions
@@ -349,49 +398,105 @@ class PRDescription:
                         filename = filename.strip()
                         link = self.git_provider.get_line_link(filename, relevant_line_start=-1)
 
-                    file_change_description = self._insert_br_after_x_chars(file_change_description, x=(delta - 5))
+                    file_change_description_br = insert_br_after_x_chars(file_change_description, x=(delta - 5))
                     pr_body += f"""
 <tr>
   <td>
     <details>
-      <summary><strong>{filename_publish}</strong></summary>
+      <summary>{filename_publish}</summary>
-      <ul>
+<hr>
-        {filename}<br><br>
-        <strong>{file_change_description}</strong>
-      </ul>
-    </details>
-  </td>
-  <td><a href="{link}"> {diff_plus_minus}</a></td>
 
+{filename}
+{file_change_description_br}
+
+
+</details>
+    
+
+  </td>
+  <td><a href="{link}">{diff_plus_minus}</a>{delta_nbsp}</td>
 </tr>                    
 """
-                pr_body += """</table></details></td></tr>"""
+                if use_collapsible_file_list:
+                    pr_body += """</table></details></td></tr>"""
+                else:
+                    pr_body += """</table></td></tr>"""
             pr_body += """</tr></tbody></table>"""
 
         except Exception as e:
             get_logger().error(f"Error processing pr files to markdown {self.pr_id}: {e}")
             pass
-        return pr_body
+        return pr_body, pr_comments
 
-    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.
-        """
-        if len(text) < x:
-            return text
 
-        words = text.split(' ')
+def count_chars_without_html(string):
-        new_text = ""
+    if '<' not in string:
-        current_length = 0
+        return len(string)
+    no_html_string = re.sub('<[^>]+>', '', string)
+    return len(no_html_string)
 
-        for word in words:
-            # Check if adding this word exceeds x characters
-            if current_length + len(word) > x:
-                new_text += "<br>"  # Insert line break
-                current_length = 0  # Reset counter
 
-            # Add the word to the new text
+def insert_br_after_x_chars(text, x=70):
-            new_text += word + " "
+    """
-            current_length += len(word) + 1  # Add 1 for the space
+    Insert <br> into a string after a word that increases its length above x characters.
+    Use proper HTML tags for code and new lines.
+    """
+    if count_chars_without_html(text) < x:
+        return text
 
-        return new_text.strip()  # Remove trailing space
+    # replace odd instances of ` with <code> and even instances of ` with </code>
+    text = replace_code_tags(text)
+
+    # convert list items to <li>
+    if text.startswith("- "):
+        text = "<li>" + text[2:]
+    text = text.replace("\n- ", '<br><li> ').replace("\n - ", '<br><li> ')
+
+    # convert new lines to <br>
+    text = text.replace("\n", '<br>')
+
+    # split text into lines
+    lines = text.split('<br>')
+    words = []
+    for i, line in enumerate(lines):
+        words += line.split(' ')
+        if i < len(lines) - 1:
+            words[-1] += "<br>"
+
+    new_text = []
+    is_inside_code = False
+    current_length = 0
+    for word in words:
+        is_saved_word = False
+        if word == "<code>" or word == "</code>" or word == "<li>" or word == "<br>":
+            is_saved_word = True
+
+        len_word = count_chars_without_html(word)
+        if not is_saved_word and (current_length + len_word > x):
+            if is_inside_code:
+                new_text.append("</code><br><code>")
+            else:
+                new_text.append("<br>")
+            current_length = 0  # Reset counter
+        new_text.append(word + " ")
+
+        if not is_saved_word:
+            current_length += len_word + 1  # Add 1 for the space
+
+        if word == "<li>" or word == "<br>":
+            current_length = 0
+
+        if "<code>" in word:
+            is_inside_code = True
+        if "</code>" in word:
+            is_inside_code = False
+    return ''.join(new_text).strip()
+
+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)

pr_agent/tools/pr_generate_labels.py

@@ -1,10 +1,12 @@
 import copy
 import re
+from functools import partial
 from typing import List, Tuple
 
 from jinja2 import Environment, StrictUndefined
 
-from pr_agent.algo.ai_handler import AiHandler
+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.pr_processing import get_pr_diff, retry_with_fallback_models
 from pr_agent.algo.token_handler import TokenHandler
 from pr_agent.algo.utils import load_yaml, set_custom_labels, get_user_labels
@@ -15,7 +17,8 @@ from pr_agent.log import get_logger
 
 
 class PRGenerateLabels:
-    def __init__(self, pr_url: str, args: list = None):
+    def __init__(self, pr_url: str, args: list = None,
+                 ai_handler: partial[BaseAiHandler,] = LiteLLMAIHandler):
         """
         Initialize the PRGenerateLabels object with the necessary attributes and objects for generating labels
         corresponding to the PR using an AI model.
@@ -31,7 +34,7 @@ class PRGenerateLabels:
         self.pr_id = self.git_provider.get_pr_id()
 
         # Initialize the AI handler
-        self.ai_handler = AiHandler()
+        self.ai_handler = ai_handler()
     
         # Initialize the variables dictionary
         self.vars = {
@@ -40,7 +43,6 @@ class PRGenerateLabels:
             "description": self.git_provider.get_pr_description(full=False),
             "language": self.main_pr_language,
             "diff": "",  # empty diff for initial calculation
-            "use_bullet_points": get_settings().pr_description.use_bullet_points,
             "extra_instructions": get_settings().pr_description.extra_instructions,
             "commit_messages_str": self.git_provider.get_commit_messages(),
             "enable_custom_labels": get_settings().config.enable_custom_labels,
@@ -82,7 +84,7 @@ class PRGenerateLabels:
             if get_settings().config.publish_output:
                 get_logger().info(f"Pushing labels {self.pr_id}")
 
-                current_labels = self.git_provider.get_labels()
+                current_labels = self.git_provider.get_pr_labels()
                 user_labels = get_user_labels(current_labels)
                 pr_labels = pr_labels + user_labels
 
@@ -132,14 +134,11 @@ class PRGenerateLabels:
         variables["diff"] = self.patches_diff  # update diff
 
         environment = Environment(undefined=StrictUndefined)
-        set_custom_labels(variables)
+        set_custom_labels(variables, self.git_provider)
+        self.variables = variables
         system_prompt = environment.from_string(get_settings().pr_custom_labels_prompt.system).render(variables)
         user_prompt = environment.from_string(get_settings().pr_custom_labels_prompt.user).render(variables)
 
-        if get_settings().config.verbosity_level >= 2:
-            get_logger().info(f"\nSystem prompt:\n{system_prompt}")
-            get_logger().info(f"\nUser prompt:\n{user_prompt}")
-
         response, finish_reason = await self.ai_handler.chat_completion(
             model=model,
             temperature=0.2,
@@ -147,9 +146,6 @@ class PRGenerateLabels:
             user=user_prompt
         )
 
-        if get_settings().config.verbosity_level >= 2:
-            get_logger().info(f"\nAI response:\n{response}")
-
         return response
 
     def _prepare_data(self):
@@ -168,4 +164,14 @@ class PRGenerateLabels:
             elif type(self.data['labels']) == str:
                 pr_types = self.data['labels'].split(',')
 
+        # convert lowercase labels to original case
+        try:
+            if "labels_minimal_to_labels_dict" in self.variables:
+                d: dict = self.variables["labels_minimal_to_labels_dict"]
+                for i, label_i in enumerate(pr_types):
+                    if label_i in d:
+                        pr_types[i] = d[label_i]
+        except Exception as e:
+            get_logger().error(f"Error converting labels to original case {self.pr_id}: {e}")
+
         return pr_types

pr_agent/tools/pr_help_message.py

@@ -0,0 +1,99 @@
+from pr_agent.config_loader import get_settings
+from pr_agent.git_providers import get_git_provider, GithubProvider
+from pr_agent.log import get_logger
+
+
+class PRHelpMessage:
+    def __init__(self, pr_url: str, args=None, ai_handler=None):
+        self.git_provider = get_git_provider()(pr_url)
+
+    async def run(self):
+        try:
+            if not self.git_provider.is_supported("gfm_markdown"):
+                self.git_provider.publish_comment(
+                    "The `Help` tool requires gfm markdown, which is not supported by your code platform.")
+                return
+
+            get_logger().info('Getting PR Help Message...')
+            relevant_configs = {'pr_help': dict(get_settings().pr_help),
+                                'config': dict(get_settings().config)}
+            get_logger().debug("Relevant configs", artifacts=relevant_configs)
+            pr_comment = "## PR Agent Walkthrough\n\n"
+            pr_comment += "🤖 Welcome to the PR Agent, an AI-powered tool for automated pull request analysis, feedback, suggestions and more."""
+            pr_comment += "\n\nHere is a list of tools you can use to interact with the PR Agent:\n"
+            base_path = "https://github.com/Codium-ai/pr-agent/tree/main/docs"
+
+            tool_names = []
+            tool_names.append(f"[DESCRIBE]({base_path}/DESCRIBE.md)")
+            tool_names.append(f"[REVIEW]({base_path}/REVIEW.md)")
+            tool_names.append(f"[IMPROVE]({base_path}/IMPROVE.md)")
+            tool_names.append(f"[ANALYZE]({base_path}/Analyze.md) 💎")
+            tool_names.append(f"[UPDATE CHANGELOG]({base_path}/UPDATE_CHANGELOG.md)")
+            tool_names.append(f"[ADD DOCUMENTATION]({base_path}/ADD_DOCUMENTATION.md) 💎")
+            tool_names.append(f"[ASK]({base_path}/ASK.md)")
+            tool_names.append(f"[GENERATE CUSTOM LABELS]({base_path}/GENERATE_CUSTOM_LABELS.md)")
+            tool_names.append(f"[TEST]({base_path}/TEST.md) 💎")
+            tool_names.append(f"[CI FEEDBACK]({base_path}/CI_FEEDBACK.md) 💎")
+            tool_names.append(f"[CUSTOM SUGGESTIONS]({base_path}/CUSTOM_SUGGESTIONS.md) 💎")
+            tool_names.append(f"[SIMILAR ISSUE]({base_path}/SIMILAR_ISSUE.md)")
+
+            descriptions = []
+            descriptions.append("Generates PR description - title, type, summary, code walkthrough and labels")
+            descriptions.append("Adjustable feedback about the PR, possible issues, security concerns, review effort and more")
+            descriptions.append("Code suggestions for improving the PR.")
+            descriptions.append("Identifies code components that changed in the PR, and enables to interactively generate tests, docs, and code suggestions for each component.")
+            descriptions.append("Automatically updates the changelog.")
+            descriptions.append("Generates documentation to methods/functions/classes that changed in the PR.")
+            descriptions.append("Answering free-text questions about the PR.")
+            descriptions.append("Generates custom labels for the PR, based on specific guidelines defined by the user")
+            descriptions.append("Generates unit tests for a specific component, based on the PR code change.")
+            descriptions.append("Generates feedback and analysis for a failed CI job.")
+            descriptions.append("Generates custom suggestions for improving the PR code, based on specific guidelines defined by the user.")
+            descriptions.append("Automatically retrieves and presents similar issues.")
+
+            commands  =[]
+            commands.append("`/describe`")
+            commands.append("`/review`")
+            commands.append("`/improve`")
+            commands.append("`/analyze`")
+            commands.append("`/update_changelog`")
+            commands.append("`/add_docs`")
+            commands.append("`/ask`")
+            commands.append("`/generate_labels`")
+            commands.append("`/test`")
+            commands.append("`/checks`")
+            commands.append("`/custom_suggestions`")
+            commands.append("`/similar_issue`")
+
+            checkbox_list = []
+            checkbox_list.append(" - [ ] Run <!-- /describe -->")
+            checkbox_list.append(" - [ ] Run <!-- /review -->")
+            checkbox_list.append(" - [ ] Run <!-- /improve -->")
+            checkbox_list.append(" - [ ] Run <!-- /analyze -->")
+            checkbox_list.append(" - [ ] Run <!-- /update_changelog -->")
+            checkbox_list.append(" - [ ] Run <!-- /add_docs -->")
+            checkbox_list.append("[*]")
+            checkbox_list.append("[*]")
+            checkbox_list.append("[*]")
+            checkbox_list.append("[*]")
+            checkbox_list.append("[*]")
+            checkbox_list.append("[*]")
+
+            if isinstance(self.git_provider, GithubProvider):
+                pr_comment += f"<table><tr align='center'><th align='center'>Tool</th><th align='center'>Description</th><th align='center'>Invoke Interactively :gem:</th></tr>"
+                for i in range(len(tool_names)):
+                    pr_comment += f"\n<tr><td align='center'>\n\n<strong>{tool_names[i]}</strong></td>\n<td>{descriptions[i]}</td>\n<td>\n\n{checkbox_list[i]}\n</td></tr>"
+                pr_comment += "</table>\n\n"
+                pr_comment += f"""\n\n(1) Note that each tool be [triggered automatically](https://github.com/Codium-ai/pr-agent/blob/main/Usage.md#github-app-automatic-tools-for-pr-actions) when a new PR is opened, or called manually by [commenting on a PR](https://github.com/Codium-ai/pr-agent/blob/main/Usage.md#online-usage)."""
+                pr_comment += f"""\n\n(2) Tools marked with [*] require additional parameters to be passed. For example, to invoke the `/ask` tool, you need to comment on a PR: `/ask "<question content>"`. See the relevant documentation for each tool for more details."""
+            else:
+                pr_comment += f"<table><tr align='center'><th align='center'>Tool</th><th align='left'>Command</th><th align='left'>Description</th></tr>"
+                for i in range(len(tool_names)):
+                    pr_comment += f"\n<tr><td align='center'>\n\n<strong>{tool_names[i]}</strong></td><td>{commands[i]}</td><td>{descriptions[i]}</td></tr>"
+                pr_comment += "</table>\n\n"
+                pr_comment += f"""\n\nNote that each tool be [invoked automatically](https://github.com/Codium-ai/pr-agent/blob/main/Usage.md#github-app-automatic-tools-for-pr-actions) when a new PR is opened, or called manually by [commenting on a PR](https://github.com/Codium-ai/pr-agent/blob/main/Usage.md#online-usage)."""
+            if get_settings().config.publish_output:
+                self.git_provider.publish_comment(pr_comment)
+        except Exception as e:
+            get_logger().error(f"Error while running PRHelpMessage: {e}")
+        return ""