Merge pull request #1316 from yu-iskw/introduce-pre-commit

Introduce pre-commit hooks and GitHub Actions

.github/workflows/build-and-test.yaml

@@ -37,5 +37,3 @@ jobs:
         name: Test dev docker
         run: |
           docker run --rm codiumai/pr-agent:test pytest -v tests/unittest
-        
-          

.github/workflows/code_coverage.yaml

@@ -37,7 +37,7 @@ jobs:
       - id: code_cov
         name: Test dev docker
         run: |
-          docker run --name test_container codiumai/pr-agent:test  pytest  tests/unittest --cov=pr_agent --cov-report term --cov-report xml:coverage.xml 
+          docker run --name test_container codiumai/pr-agent:test  pytest  tests/unittest --cov=pr_agent --cov-report term --cov-report xml:coverage.xml
           docker cp test_container:/app/coverage.xml coverage.xml
           docker rm test_container
 
@@ -51,4 +51,4 @@ jobs:
       - name: Upload coverage to Codecov
         uses: codecov/codecov-action@v4.0.1
         with:
-          token: ${{ secrets.CODECOV_TOKEN }}
+          token: ${{ secrets.CODECOV_TOKEN }}

.github/workflows/docs-ci.yaml

@@ -1,4 +1,4 @@
-name: docs-ci 
+name: docs-ci
 on:
   push:
     branches:
@@ -20,14 +20,14 @@ jobs:
       - uses: actions/setup-python@v5
         with:
           python-version: 3.x
-      - run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV 
+      - 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
       - run: pip install "mkdocs-material[imaging]"
       - run: pip install mkdocs-glightbox
       - run: mkdocs gh-deploy -f docs/mkdocs.yml --force

.github/workflows/e2e_tests.yaml

@@ -43,4 +43,4 @@ jobs:
       - id: test3
         name: E2E bitbucket app
         run: |
-          docker run -e BITBUCKET.USERNAME=${{ secrets.BITBUCKET_USERNAME }}  -e BITBUCKET.PASSWORD=${{ secrets.BITBUCKET_PASSWORD }} --rm codiumai/pr-agent:test pytest -v tests/e2e_tests/test_bitbucket_app.py
+          docker run -e BITBUCKET.USERNAME=${{ secrets.BITBUCKET_USERNAME }}  -e BITBUCKET.PASSWORD=${{ secrets.BITBUCKET_PASSWORD }} --rm codiumai/pr-agent:test pytest -v tests/e2e_tests/test_bitbucket_app.py

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

@@ -1,4 +1,4 @@
-# This workflow enables developers to call PR-Agents `/[actions]` in PR's comments and upon PR creation. 
+# This workflow enables developers to call PR-Agents `/[actions]` in PR's comments and upon PR creation.
 # Learn more at https://www.codium.ai/pr-agent/
 # This is v0.2 of this workflow file
 
@@ -30,6 +30,3 @@ jobs:
           GITHUB_ACTION_CONFIG.AUTO_DESCRIBE: true
           GITHUB_ACTION_CONFIG.AUTO_REVIEW: true
           GITHUB_ACTION_CONFIG.AUTO_IMPROVE: true
-
-
-

.github/workflows/pre-commit.yml

@@ -0,0 +1,15 @@
+name: pre-commit
+
+on:
+  pull_request:
+  push:
+    branches: [main]
+
+jobs:
+  pre-commit:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-python@v5
+      # SEE https://github.com/pre-commit/action
+      - uses: pre-commit/action@v3.0.1

.gitignore

@@ -8,4 +8,4 @@ dist/
 *.egg-info/
 build/
 .DS_Store
-docs/.cache/
+docs/.cache/

.pre-commit-config.yaml

@@ -0,0 +1,46 @@
+# See https://pre-commit.com for more information
+# See https://pre-commit.com/hooks.html for more hooks
+
+default_language_version:
+  python: python3
+
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v5.0.0
+    hooks:
+      - id: check-added-large-files
+      - id: check-toml
+      - id: check-yaml
+      - id: end-of-file-fixer
+      - id: trailing-whitespace
+  # - repo: https://github.com/rhysd/actionlint
+  #   rev: v1.7.3
+  #   hooks:
+  #     - id: actionlint
+  - repo: https://github.com/pycqa/isort
+    # rev must match what's in dev-requirements.txt
+    rev: 5.13.2
+    hooks:
+      - id: isort
+  # - repo: https://github.com/PyCQA/bandit
+  #   rev: 1.7.10
+  #   hooks:
+  #     - id: bandit
+  #       args: [
+  #         "-c", "pyproject.toml",
+  #       ]
+  # - repo: https://github.com/astral-sh/ruff-pre-commit
+  #   rev: v0.7.1
+  #   hooks:
+  #     - id: ruff
+  #       args:
+  #         - --fix
+  #     - id: ruff-format
+  # -   repo: https://github.com/PyCQA/autoflake
+  #     rev: v2.3.1
+  #     hooks:
+  #     -   id: autoflake
+  #         args:
+  #           - --in-place
+  #           - --remove-all-unused-imports
+  #           - --remove-unused-variables

LICENSE

@@ -199,4 +199,4 @@
    distributed under the License is distributed on an "AS IS" BASIS,
    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    See the License for the specific language governing permissions and
-   limitations under the License.
+   limitations under the License.

MANIFEST.in

@@ -1,2 +1,2 @@
 recursive-include pr_agent *.toml
-recursive-exclude pr_agent *.secrets.toml
+recursive-exclude pr_agent *.secrets.toml

README.md

@@ -40,7 +40,7 @@ Qode Merge PR-Agent aims to help efficiently review and handle pull requests, by
 - [PR-Agent Pro 💎](https://pr-agent-docs.codium.ai/overview/pr_agent_pro/)
 - [How it works](#how-it-works)
 - [Why use PR-Agent?](#why-use-pr-agent)
-  
+
 ## News and Updates
 
 ### November 7, 2024
@@ -87,7 +87,7 @@ Read more about this novel feature [here](https://qodo-merge-docs.qodo.ai/tools/
 
 
 ### October 21, 2024
-**Disable publishing labels by default:** 
+**Disable publishing labels by default:**
 
 The default setting for `pr_description.publish_labels` has been updated to `false`. This means that labels generated by the `/describe` tool will no longer be published, unless this configuration is explicitly set to `true`.
 
@@ -290,7 +290,7 @@ Note that when you set your own PR-Agent or use CodiumAI hosted PR-Agent, there
 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\GitLab\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. 
+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://qodo-merge-docs.qodo.ai/overview/pr_agent_pro/) for a list of features available in PR-Agent Pro.
 
 

RELEASE_NOTES.md

@@ -88,7 +88,7 @@ Significant documentation updates (see [Installation Guide](https://github.com/C
 - codiumai/pr-agent:0.7-gitlab_webhook
 - codiumai/pr-agent:0.7-github_polling
 - codiumai/pr-agent:0.7-github_action
- 
+
 ### Added::Algo
 - New tool /similar_issue - Currently on GitHub app and CLI: indexes the issues in the repo, find the most similar issues to the target issue.
 - Describe markers: Empower the /describe tool with a templating capability (see more details in https://github.com/Codium-ai/pr-agent/pull/273).

docs/docs/chrome-extension/data_privacy.md

@@ -2,4 +2,3 @@ We take your code's security and privacy seriously:
 
 - The Chrome extension will not send your code to any external servers.
 - For private repositories, we will first validate the user's identity and permissions. After authentication, we generate responses using the existing Qodo Merge Pro integration.
-

docs/docs/chrome-extension/index.md

@@ -2,7 +2,7 @@
 
 With a single-click installation you will gain access to a context-aware chat on your pull requests code, a toolbar extension with multiple AI feedbacks, Qodo Merge filters, and additional abilities.
 
-The extension is powered by top code models like Claude 3.5 Sonnet and GPT4. All the extension's features are free to use on public repositories. 
+The extension is powered by top code models like Claude 3.5 Sonnet and GPT4. All the extension's features are free to use on public repositories.
 
 For private repositories, you will need to install [Qodo Merge Pro](https://github.com/apps/codiumai-pr-agent-pro) in addition to the extension  (Quick GitHub app setup with a 14-day free trial. No credit card needed).
 For a demonstration of how to install Qodo Merge Pro and use it with the Chrome extension, please refer to the tutorial video at the provided [link](https://codium.ai/images/pr_agent/private_repos.mp4).

docs/docs/core-abilities/code_oriented_yaml.md

@@ -1,2 +1,2 @@
 ## Overview
-TBD
+TBD

docs/docs/core-abilities/compression_strategy.md

@@ -12,9 +12,9 @@ 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
-3. 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
 In this case, we can fit the entire PR in a single prompt:

docs/docs/core-abilities/dynamic_context.md

@@ -1,7 +1,7 @@
 ## TL;DR
 
-Qodo Merge uses an **asymmetric and dynamic context strategy** to improve AI analysis of code changes in pull requests. 
-It provides more context before changes than after, and dynamically adjusts the context based on code structure (e.g., enclosing functions or classes). 
+Qodo Merge uses an **asymmetric and dynamic context strategy** to improve AI analysis of code changes in pull requests.
+It provides more context before changes than after, and dynamically adjusts the context based on code structure (e.g., enclosing functions or classes).
 This approach balances providing sufficient context for accurate analysis, while avoiding needle-in-the-haystack information overload that could degrade AI performance or exceed token limits.
 
 ## Introduction
@@ -17,12 +17,12 @@ Pull request code changes are retrieved in a unified diff format, showing three
  code line that already existed in the file...
  code line that already existed in the file...
  code line that already existed in the file...
- 
+
 @@ -26,2 +26,4 @@ def func2():
 ...
 ```
 
-This unified diff format can be challenging for AI models to interpret accurately, as it provides limited context for understanding the full scope of code changes. 
+This unified diff format can be challenging for AI models to interpret accurately, as it provides limited context for understanding the full scope of code changes.
 The presentation of code using '+', '-', and ' ' symbols to indicate additions, deletions, and unchanged lines respectively also differs from the standard code formatting typically used to train AI models.
 
 
@@ -37,7 +37,7 @@ Pros:
 Cons:
 
 - Excessive context may overwhelm the model with extraneous information, creating a "needle in a haystack" scenario where focusing on the relevant details (the code that actually changed) becomes challenging.
-LLM quality is known to degrade when the context gets larger. 
+LLM quality is known to degrade when the context gets larger.
 Pull requests often encompass multiple changes across many files, potentially spanning hundreds of lines of modified code. This complexity presents a genuine risk of overwhelming the model with excessive context.
 
 - Increased context expands the token count, increasing processing time and cost, and may prevent the model from processing the entire pull request in a single pass.
@@ -47,18 +47,18 @@ To address these challenges, Qodo Merge employs an **asymmetric** and **dynamic*
 
 **Asymmetric:**
 
-We start by recognizing that the context preceding a code change is typically more crucial for understanding the modification than the context following it. 
+We start by recognizing that the context preceding a code change is typically more crucial for understanding the modification than the context following it.
 Consequently, Qodo Merge implements an asymmetric context policy, decoupling the context window into two distinct segments: one for the code before the change and another for the code after.
 
-By independently adjusting each context window, Qodo Merge can supply the model with a more tailored and pertinent context for individual code changes. 
+By independently adjusting each context window, Qodo Merge can supply the model with a more tailored and pertinent context for individual code changes.
 
 **Dynamic:**
 
 We also employ a "dynamic" context strategy.
-We start by recognizing that the optimal context for a code change often corresponds to its enclosing code component (e.g., function, class), rather than a fixed number of lines. 
+We start by recognizing that the optimal context for a code change often corresponds to its enclosing code component (e.g., function, class), rather than a fixed number of lines.
 Consequently, we dynamically adjust the context window based on the code's structure, ensuring the model receives the most pertinent information for each modification.
 
-To prevent overwhelming the model with excessive context, we impose a limit on the number of lines searched when identifying the enclosing component. 
+To prevent overwhelming the model with excessive context, we impose a limit on the number of lines searched when identifying the enclosing component.
 This balance allows for comprehensive understanding while maintaining efficiency and limiting context token usage.
 
 ## Appendix - relevant configuration options
@@ -69,4 +69,4 @@ allow_dynamic_context=true                  # Allow dynamic context extension
 max_extra_lines_before_dynamic_context = 8  # will try to include up to X extra lines before the hunk in the patch, until we reach an enclosing function or class
 patch_extra_lines_before = 3                # Number of extra lines (+3 default ones) to include before each hunk in the patch
 patch_extra_lines_after = 1                 # Number of extra lines (+3 default ones) to include after each hunk in the patch
-```
+```

docs/docs/core-abilities/impact_evaluation.md

@@ -41,4 +41,4 @@ Here are key metrics that the dashboard tracks:
 
 #### Suggestion Score Distribution
 ![Impacted_Suggestion_Score](https://codium.ai/images/pr_agent/impacted_score_dist.png){width=512}
-> Explanation: The distribution of the suggestion score for the implemented suggestions, ensuring that higher-scored suggestions truly represent more significant improvements. 
+> Explanation: The distribution of the suggestion score for the implemented suggestions, ensuring that higher-scored suggestions truly represent more significant improvements.

docs/docs/core-abilities/index.md

@@ -14,7 +14,7 @@ Qodo Merge utilizes a variety of core abilities to provide a comprehensive and e
 
 ## Blogs
 
-Here are some additional technical blogs from Qodo, that delve deeper into the core capabilities and features of Large Language Models (LLMs) when applied to coding tasks. 
+Here are some additional technical blogs from Qodo, that delve deeper into the core capabilities and features of Large Language Models (LLMs) when applied to coding tasks.
 These resources provide more comprehensive insights into leveraging LLMs for software development.
 
 ### Code Generation and LLMs
@@ -26,4 +26,4 @@ These resources provide more comprehensive insights into leveraging LLMs for sof
 - [Introduction to Code Coverage Testing](https://www.qodo.ai/blog/introduction-to-code-coverage-testing/)
 
 ### Cost Optimization
-- [Reduce Your Costs by 30% When Using GPT for Python Code](https://www.qodo.ai/blog/reduce-your-costs-by-30-when-using-gpt-3-for-python-code/)
+- [Reduce Your Costs by 30% When Using GPT for Python Code](https://www.qodo.ai/blog/reduce-your-costs-by-30-when-using-gpt-3-for-python-code/)

docs/docs/core-abilities/interactivity.md

@@ -1,2 +1,2 @@
 ## Interactive invocation 💎
-TBD
+TBD

docs/docs/core-abilities/metadata.md

@@ -53,4 +53,4 @@ __old hunk__
 
 
 (4) All the metadata described above represents several level of cumulative analysis - ranging from hunk level, to file level, to PR level, to organization level.
-This comprehensive approach enables Qodo Merge AI models to generate more precise and contextually relevant suggestions and feedback.
+This comprehensive approach enables Qodo Merge AI models to generate more precise and contextually relevant suggestions and feedback.