Compare commits

...

365 Commits
v0.29 ... main

Author SHA1 Message Date
Tal
6dc38e5bca Merge pull request #1909 from qodo-ai/tr/dedent_tabs
fix: improve indentation handling in code suggestions
2025-07-01 17:25:24 +03:00
f7efa2c7c7 fix: improve indentation handling in code suggestions 2025-07-01 17:10:01 +03:00
e1a112d26e docs: update last updated date and correct typo in README 2025-07-01 11:48:01 +03:00
1b46d64d71 docs: update Qodo Merge feedback descriptions in README and index 2025-07-01 11:39:58 +03:00
Tal
38eda2f7b6 Merge pull request #1907 from qodo-ai/tr/qm_post_commit
docs: update sequence diagram support section and recent updates
2025-07-01 11:33:00 +03:00
Tal
53b9c8ec97 Update docs/docs/recent_updates/index.md
Co-authored-by: qodo-merge-for-open-source[bot] <189517486+qodo-merge-for-open-source[bot]@users.noreply.github.com>
2025-07-01 11:32:53 +03:00
7e8e95b748 docs: correct typo in README and update Mermaid diagram link in index 2025-07-01 11:31:08 +03:00
7f51661e64 docs: update sequence diagram support section and recent updates 2025-07-01 11:28:33 +03:00
Tal
70023d2c4f Merge pull request #1905 from qodo-ai/es/update_docs_incremental_improve
Update docs that Gitlab also supports Incremental Update
2025-06-30 17:30:20 +03:00
c5d34f5ad5 Update docs that Gitlab also supports Incremental Update 2025-06-30 17:07:14 +03:00
Tal
8d3e51c205 Merge pull request #1904 from qodo-ai/tr/suggestions_depth
Tr/suggestions depth
2025-06-29 11:26:28 +03:00
b213753420 ד 2025-06-29 11:26:07 +03:00
2eb8019325 docs: clarify that PR diagram is enabled by default in describe tool 2025-06-29 11:24:31 +03:00
9115cb7d31 docs: add link to generated_code_ignore.toml file 2025-06-29 11:09:37 +03:00
Tal
62adad8f12 Merge pull request #1903 from qodo-ai/tr/suggestions_depth
docs: add suggestions_depth configuration parameter documentation
2025-06-29 10:50:41 +03:00
56f7ae0b46 docs: add suggestions_depth configuration parameter documentation 2025-06-29 10:37:12 +03:00
Tal
446c1fb49a Merge pull request #1898 from isExample/feat/ignore-language-framework
feat: support ignoring auto-generated files by language/framework
2025-06-29 10:19:37 +03:00
7d50625bd6 test: skip filtering when ignore_language_framework is misconfigured 2025-06-29 02:18:29 +09:00
bd9ddc8b86 fix: avoid crash when ignore_language_framework is not a list 2025-06-29 02:06:40 +09:00
Tal
dd4fe4dcb4 Merge pull request #1897 from qodo-ai/tr/pr_diagram
feat: enable PR diagram by default and improve mermaid diagram genera…
2025-06-27 11:46:58 +03:00
Tal
1c174f263f Merge pull request #1892 from dcieslak19973/pr-agent-1886-add-bedrock-llama4-20250622
Add bedrock Llama 4 Scout/Maverick
2025-06-27 11:16:49 +03:00
Tal
d860e17b3b Merge pull request #1891 from jmsb02/test/add_docs_trigger
test: auto-trigger /add_docs on PR opened events
2025-06-26 17:38:34 +03:00
Tal
f83970bc6b Merge pull request #1895 from rppavan/main
gemini 2.5 flash/pro GA models
2025-06-26 12:28:20 +03:00
87a245bf9c fix: support root-level matching for '**/' globs
- generate an additional regex to match root-level files alongside '**/' patterns.
- ensure files in the repo root are correctly excluded from analysis.
2025-06-26 15:26:12 +09:00
2d1afc634e docs: ignore_language_framework property 2025-06-26 13:43:18 +09:00
e4f477dae0 test: add filtering test for auto-generated files 2025-06-26 13:32:27 +09:00
8e210f8ea0 chore: update generated code sources 2025-06-26 13:29:59 +09:00
Tal
9c87056263 Merge pull request #1890 from abishlal/feature/support-tickets-context-in-azdo
Enhance Azure DevOps Integration with Work Item Ticket Retrieval and Comment Thread Updates
2025-06-25 20:40:22 +03:00
3251f19a19 fix: change comment thread status to closed when publishing comments
Signed-off-by: abishlal <abishlalns03@gmail.com>
2025-06-25 20:59:34 +05:30
299a2c89d1 feat: add tags extraction from work item fields in Azure DevOps provider
Signed-off-by: abishlal <abishlalns03@gmail.com>
2025-06-25 20:57:56 +05:30
c7241ca093 feat: support ignore_language_framework via generated_code_ignore.toml
- [generated_code] table defines default glob patterns for code-generation tools
- merge generated_code globs into ignore logic
2025-06-25 23:39:14 +09:00
1a00e61239 feat: add configuration property 'ignore_language_framework' 2025-06-25 23:17:42 +09:00
Tal
f166e7f497 Merge pull request #1894 from qodo-ai/es/improve_response_ai_search
More informative error message in case search returned an error
2025-06-24 20:17:52 +03:00
8dc08e4596 Modify search answers according to feedback. 2025-06-24 18:39:41 +03:00
ead2c9273f feat: enable PR diagram by default and improve mermaid diagram generation 2025-06-24 17:28:23 +03:00
5062543325 More code suggestion fixes 2025-06-24 13:02:12 +03:00
35e865bfb6 Implement suggestions 2025-06-24 12:57:57 +03:00
abb576c84f - More informative error message in case search returned an error
- Report no results found in case of an empty response
2025-06-24 12:34:32 +03:00
2d61ff7b88 gemini 2.5 slash/pro GA models
Adding stable/GA models of gemini-2.5 models.
Added gemini-2.5-pro and gemini-2.5-flash both to vertex_ai and gemini configs
2025-06-24 11:06:01 +05:30
e75b863f3b docs: clarify PR feedback quota wording and formatting 2025-06-23 11:18:09 +03:00
849cb2ea5a Change token limit to 128k for Bedrock Llama 2025-06-22 14:36:41 -05:00
ab80677e3a Merge remote-tracking branch 'origin/main' 2025-06-22 21:16:00 +03:00
bd7017d630 bitbucket json 2025-06-22 21:15:45 +03:00
Tal
6e2bc01294 Merge pull request #1884 from alessio-locatelli/handle_500_Internal_Server_Error
feat: wrap the command's entry point to catch all errors
2025-06-22 21:07:06 +03:00
22c16f586b Add bedrock Llama 4 Scout/Maverick 2025-06-22 11:05:08 -05:00
a42e3331d8 test: auto-trigger /add_docs on PR opened events 2025-06-23 00:06:18 +09:00
e14834c84e docs: update PR benchmark results section header 2025-06-22 10:17:51 +03:00
915a1c563b docs: add Codex-mini model evaluation to PR benchmark results 2025-06-22 09:53:26 +03:00
bc99cf83dd feat: add a bare except to catch all errors 2025-06-21 15:34:02 +03:00
d00cbd4da7 Revert "fix: do not fail the CLI when GitLab API return 5xx code"
This reverts commit 68f78e1a30.
2025-06-21 15:28:27 +03:00
721ff18a63 Revert "fix: wrap _handle_request to handle 5xx responses"
This reverts commit 1a003fe4d3.
2025-06-21 15:27:41 +03:00
1a003fe4d3 fix: wrap _handle_request to handle 5xx responses 2025-06-21 15:26:48 +03:00
68f78e1a30 fix: do not fail the CLI when GitLab API return 5xx code 2025-06-21 15:26:48 +03:00
7759d1d3fc fix: remove redundant state and labels fields from ticket data extraction
Signed-off-by: abishlal <abishlalns03@gmail.com>
2025-06-21 17:31:24 +05:30
738f9856a4 feat: add WorkItemTrackingClient to Azure DevOps provider and update client return type
Signed-off-by: abishlal <abishlalns03@gmail.com>
2025-06-21 17:28:59 +05:30
fbce8cd2f5 fix: update comment thread status to active when publishing comments
Signed-off-by: abishlal <abishlalns03@gmail.com>
2025-06-21 17:22:24 +05:30
ea63c8e63a fix: remove redundant line for BasicAuthentication in Azure DevOps provider
Signed-off-by: abishlal <abishlalns03@gmail.com>
2025-06-21 17:22:04 +05:30
d8fea6afc4 feat: enhance Azure DevOps integration by adding work item as a ticket retrieval methods - Supporting ticket context for Azure DevOps
Signed-off-by: abishlal <abishlalns03@gmail.com>
2025-06-21 17:20:31 +05:30
ff16e1cd26 build: add wheel to build requirements and update license configuration 2025-06-21 13:12:27 +03:00
9b5ae1a322 chore: bump version to 0.3.0 and update license to AGPL-3.0 2025-06-21 12:52:45 +03:00
8b8464163d docs: update recent updates with v0.30 release and best practices hierarchy 2025-06-21 12:46:03 +03:00
eb4cdbb115 fix: remove branch parameter from get_content_of_file call in bitbucket server provider 2025-06-21 12:34:00 +03:00
Tal
7f54b14b4d Merge pull request #1874 from yoohya/feat/support-gitlab-lambda-webhooks
feat: Support GitLab webhooks in Lambda functions
2025-06-21 09:36:16 +03:00
938ab9a139 fix: remove redundant word 'possible' from security concerns field description 2025-06-21 09:31:55 +03:00
Tal
75bde39b03 Merge pull request #1888 from qodo-ai/tr/simplify_toDo
refactor: extract TODO formatting functions and simplify data structure
2025-06-21 09:30:18 +03:00
Tal
ee36c0208c Update pr_agent/settings/pr_reviewer_prompts.toml
Co-authored-by: qodo-merge-for-open-source[bot] <189517486+qodo-merge-for-open-source[bot]@users.noreply.github.com>
2025-06-21 09:23:11 +03:00
7c02678ba5 refactor: extract TODO formatting functions and simplify data structure 2025-06-21 09:20:43 +03:00
235df737d0 docs: update Docker image tags 2025-06-20 23:22:13 +09:00
37ef4bad8f docs: add bullet point formatting instruction to PR description prompts 2025-06-20 16:27:43 +03:00
ab7e0d9141 refactor: split serverless handlers into dedicated GitHub and GitLab Lambda entrypoints 2025-06-20 04:18:42 +09:00
Tal
7db4d97fc2 Merge pull request #1880 from alessio-locatelli/fix_yes_no
fix: typos, grammar
2025-06-18 20:22:02 +03:00
Tal
3e1cf2deed Merge pull request #1869 from PullPullers/feat/review-todo-section
feat: surface TODO comments in review tool
2025-06-18 20:15:43 +03:00
4a00854b15 fix: exclude TODO prompt if require_todo_scan is false 2025-06-18 18:50:11 +09:00
d4a52ffc93 refactor: clarify TODO field description and simplify 'No' return 2025-06-18 18:45:49 +09:00
c4ccfd865d fix: shorten todo summary prompt for balance
related comment: https://github.com/qodo-ai/pr-agent/pull/1869#discussion_r2151443243
2025-06-18 18:45:49 +09:00
38f10e10fa style: remove entry info from the todo section header
related comment: https://github.com/qodo-ai/pr-agent/pull/1869#issuecomment-2979088345
2025-06-18 18:45:49 +09:00
2cfe52e294 refactor: replace DynaBox import with string type checking 2025-06-18 10:04:51 +03:00
Tal
1c34450645 Merge pull request #1883 from letzya/patch-1
Update github_action_runner.py
2025-06-18 09:45:49 +03:00
8325a8aeb1 feat: improve TODO sections closed by default 2025-06-18 13:48:51 +09:00
081310b943 style: refine layout of TODO section (add <br><br>) 2025-06-18 13:08:05 +09:00
c75fb2137b style: replace todo emoji with 📝 2025-06-18 13:04:14 +09:00
6de821719f fix: update default value of require_todo_scan from true to false in docs 2025-06-18 12:52:26 +09:00
4662f65146 Update github_action_runner.py
9789e5d701/pr_agent/agent/pr_agent.py (L84)
2025-06-17 19:04:03 +01:00
9789e5d701 docs: clarify auto-approval ticket compliance applies to review tool path only 2025-06-17 16:31:46 +03:00
5b7f8a4bb6 fix: grammar 2025-06-17 09:52:34 +03:00
608065f2ad fix: typos 2025-06-17 09:26:57 +03:00
7ee4c4aad1 fix: yes/no spelling 2025-06-17 09:13:12 +03:00
Tal
1c5f203b52 Merge pull request #1871 from smallfish06/main
Add language-specific instructions to extra instructions based on user settings
2025-06-17 08:34:21 +03:00
Tal
d4e8f618ce Update pr_agent/servers/github_action_runner.py
Co-authored-by: qodo-merge-for-open-source[bot] <189517486+qodo-merge-for-open-source[bot]@users.noreply.github.com>
2025-06-17 08:34:07 +03:00
Tal
b7b4d00f57 Merge pull request #1868 from NicoFgrx/main
feat: support self-signed gitea cert
2025-06-17 08:21:40 +03:00
76aa66b534 docs: add blank line before GitHub Enterprise Server installation note 2025-06-16 20:11:31 +03:00
9a2bfb4d64 docs: clarify GitHub Enterprise Server installation requirements for Qodo Merge 2025-06-16 20:08:27 +03:00
f39e0a13f4 Revert linted line breaks 2025-06-16 10:56:24 +09:00
5d721376fe Move language-specific instructions to github_action_runner.py 2025-06-16 10:53:38 +09:00
1963b80b46 docs: fix indentation in GitLab installation guide 2025-06-16 03:41:17 +09:00
678bc9d911 docs: add Go language support to static code analysis and analyze tool documentation 2025-06-15 21:31:08 +03:00
a5c61e33d3 docs: fix indentation in GitLab installation guide 2025-06-16 02:10:15 +09:00
99904601ce feat: Support GitLab webhooks in Lambda functions 2025-06-16 01:22:01 +09:00
cbea0380ec docs: reorder auto approval in core abilities navigation and comment out compression strategy 2025-06-15 09:28:00 +03:00
4e466c07f9 docs: standardize core abilities documentation headers and platform support format 2025-06-15 09:17:11 +03:00
Tal
00daae1405 Merge pull request #1873 from qodo-ai/tr/new_benchmark23
docs: refactor auto-approval documentation into dedicated core abilit…
2025-06-15 09:04:58 +03:00
Tal
10350ae58e Update docs/docs/core-abilities/auto_approval.md
Co-authored-by: qodo-merge-for-open-source[bot] <189517486+qodo-merge-for-open-source[bot]@users.noreply.github.com>
2025-06-15 09:04:36 +03:00
cf31e7c974 docs: refactor auto-approval documentation into dedicated core abilities section 2025-06-15 09:02:04 +03:00
Tal
96150495f8 Merge pull request #1872 from qodo-ai/tr/new_benchmark23
tickets docs
2025-06-15 08:20:16 +03:00
25b07441a9 unrelated 2025-06-13 20:44:30 +03:00
ce062adf39 docs: enhance ticket compliance documentation with new label and configuration options 2025-06-13 20:41:14 +03:00
4bac78b1b9 docs: add gitea self signed configuration 2025-06-13 19:16:13 +02:00
Tal
de8913e905 Merge pull request #1859 from alessio-locatelli/respect_publish_output_no_suggestions_by_reviewer
feat: support 'publish_output_no_suggestions' by 'pr_reviewer'
2025-06-13 19:42:32 +03:00
9b19935f47 Add language-specific instructions to extra instructions based on user settings 2025-06-13 19:42:14 +09:00
3b42b0e152 refactor: simplify IF/ELSE block 2025-06-12 18:15:46 +03:00
eff45e832c docs: clarify JIRA ticket reference formats and organization identifier usage 2025-06-12 17:57:58 +03:00
94253853cd refactor: reuse IF condition in _should_publish_review 2025-06-12 17:54:13 +03:00
e8770beba1 fix: correct IF/ELSE block 2025-06-12 17:35:33 +03:00
8d2e92fe83 feat: support 'publish_output_no_suggestions' by 'pr_reviewer'
The tool reuses the existing variable name.
The change is non-breaking because by default it keeps the old behavior.
2025-06-12 17:35:33 +03:00
Tal
9c17a3902b Merge pull request #1856 from cesdperez/feat/gitlab-changelogmd-support
Add GitLab support for CHANGELOG.md
2025-06-12 17:04:03 +03:00
3faab424a4 feat: support self-signed gitea cert 2025-06-12 16:01:26 +02:00
7a0c350760 feat: Change default TODO flag value from true to false 2025-06-12 18:14:19 +09:00
Tal
3c572306cf Merge pull request #1866 from qodo-ai/tr/new_benchmark23
docs: update PR benchmark to ranking-based methodology with expanded …
2025-06-12 10:24:25 +03:00
3c1f47b4e9 docs: update PR benchmark to ranking-based methodology with expanded model results 2025-06-12 10:22:23 +03:00
39067a07ef docs: update default models to Claude Sonnet 4 and refresh date to June 2025 2025-06-11 19:27:49 +03:00
d812b7ed7e Fixed comment 5 2025-06-11 11:26:49 +02:00
4fa65fec93 Merge branch 'main' into feat/gitlab-changelogmd-support 2025-06-11 11:21:34 +02:00
7f02ba5c8f Merge remote-tracking branch 'origin/main' 2025-06-11 10:43:43 +03:00
d4c2e2f483 docs: clarify PR auto-blocking functionality in review tool documentation 2025-06-11 10:43:36 +03:00
ca05b798ca fix: display no TODO comments section 2025-06-10 22:56:28 +09:00
b0711929c3 Merge pull request #4 from PullPullers/feat/toggle-open-based-on-line-count-for-todo-section
todo section의 내용이 10줄 이하이면 기본적으로 펼쳐져 있도록 수정
2025-06-10 21:41:30 +09:00
f09e1edb13 refactor: remove count info from todo summary 2025-06-09 22:26:37 +09:00
9230be86e9 refactor: handle singular/plural forms of entry 2025-06-09 21:40:33 +09:00
6c05c6685e fix: use | for multiline in YAML instead of \n for todo content prompts 2025-06-09 20:54:14 +09:00
3904743e85 Fixed comment 4 2025-06-07 21:13:16 +02:00
fe9afb826d Fixed comment 3 2025-06-07 21:09:38 +02:00
a550c17466 Fixed comment 2 2025-06-07 21:06:12 +02:00
04cb8af65d Fixed comment 1 2025-06-07 21:02:56 +02:00
122248ef9c Add GitLab support for CHANGELOG.md 2025-06-07 20:48:33 +02:00
277c6abf0f refactor: standardizes todo_sections and todos_summary formatting 2025-06-07 08:42:28 +09:00
829417ce6e feat: toggle open or closed based on line count for todo section 2025-06-07 08:42:19 +09:00
c635887949 docs: remove none-existing webpage and update documentation admonition styles to allow collapsible format 2025-06-06 15:40:47 +03:00
4fdbcdf86a docs: add Gitea support to feature compatibility table 2025-06-06 15:25:34 +03:00
Tal
4c006eba47 Merge pull request #1851 from kebhr/feature/support_cross_region_for_apac
chore: add APAC region endpoints for Bedrock Anthropic Claude models
2025-06-05 20:52:27 +03:00
Tal
3b84203d4c Merge pull request #1852 from SCREEN88/fix/gitea-get-file-content-error
Fix gitea get file content error
2025-06-05 20:51:13 +03:00
Tal
ee4b847da0 Merge pull request #1853 from PeterDaveHelloKitchen/Gemini-2.5-Pro-Preview-06-05
Add Google Gemini 2.5 Pro Preview 06-05
2025-06-05 20:48:38 +03:00
fa435cfc1e Add Google Gemini 2.5 Pro Preview 06-05
Reference:
- https://blog.google/products/gemini/gemini-2-5-pro-latest-preview
2025-06-06 01:17:27 +08:00
dc9e9af9f8 refactor: rename file line to file reference 2025-06-05 22:26:03 +09:00
dc6460361b Merge pull request #3 from PullPullers/feedback/review-todo-section
Feedback/review todo section
2025-06-05 22:15:18 +09:00
37781c59e7 Add forgejo statuses check in gitea get_diff_files method 2025-06-05 16:02:55 +03:00
865798ef3f Fix wrong parameters for gitea get_file_content method 2025-06-05 16:01:18 +03:00
c190b93c4f chore: add APAC region endpoints for Bedrock Anthropic Claude models 2025-06-05 19:37:46 +09:00
Tal
1bbc673588 Merge pull request #1850 from qodo-ai/hl/update_bb_app_pp
Update atlassian-connect.json
2025-06-05 10:45:47 +03:00
ac72d6f6c2 Update atlassian-connect.json 2025-06-05 10:37:51 +03:00
4977db5578 docs: remove duplicate note about /add_docs not being triggered automatically 2025-06-05 07:59:35 +03:00
a2500633e2 Merge pull request #1845 from qodo-ai/hl/multi_jira_server_docs
Hl/multi jira server docs
2025-06-04 21:34:00 +03:00
d8fb24c971 refactor: remove unused HTML formatting function from utils 2025-06-04 20:18:46 +09:00
3f9cade14d feat: add todos_summary to review output in markdown conversion 2025-06-04 20:18:46 +09:00
4a7757be3f docs: convert best practices label section to collapsible info box format 2025-06-04 08:40:37 +03:00
2c976fef72 docs: convert info box to standard heading for hierarchical best practices setup 2025-06-04 08:32:12 +03:00
2a84c841da Merge pull request #1844 from qodo-ai/of/best-practices-hierarchy
docs: add global hierarchical best practices system
2025-06-04 08:14:46 +03:00
a9d6a615fd Update fetching_ticket_context.md 2025-06-03 15:11:00 +03:00
e561f0358c Update fetching_ticket_context.md 2025-06-03 15:08:09 +03:00
9e238dd991 Update fetching_ticket_context.md 2025-06-03 14:57:46 +03:00
5917903a5a docs: implement hierarchical best practices system with detailed documentation 2025-06-03 13:46:06 +03:00
Tal
7d21c84c93 Merge pull request #1832 from qodo-ai/tr/trial_usage
docs: update trial usage information to reflect new quota-based model
2025-06-03 08:45:44 +03:00
50e331476d docs: update recent updates page to reflect the launch of simplified free tier 2025-06-03 08:45:10 +03:00
48ab5a4018 docs: add information about Qodo Merge free tier to README 2025-06-03 08:41:54 +03:00
be20c9ab3b Merge remote-tracking branch 'origin/main' into tr/trial_usage 2025-06-03 08:39:15 +03:00
ecb39856ee fix tests 2025-06-02 18:04:44 +03:00
Tal
b6787fa6de Merge pull request #1839 from yamoyamoto/gucci/feat/aws-secrets-manager-integration
feat: add AWS Secrets Manager Integration for Lambda deployments
2025-06-02 16:48:25 +03:00
c520a8658f chore: update secret more robustly
Co-authored-by: qodo-merge-pro-for-open-source[bot] <189517486+qodo-merge-pro-for-open-source[bot]@users.noreply.github.com>
2025-06-02 13:48:47 +09:00
e2867f3a19 chore: get settings more safer
Co-authored-by: qodo-merge-pro-for-open-source[bot] <189517486+qodo-merge-pro-for-open-source[bot]@users.noreply.github.com>
2025-06-02 13:48:16 +09:00
5856a9e548 docs: refine descriptions in recent updates page for clarity and consistency 2025-06-01 12:24:25 +03:00
8b563b0143 Merge remote-tracking branch 'origin/main' 2025-06-01 12:20:31 +03:00
9b06f46563 docs: update recent updates page with new features and roadmap changes 2025-06-01 12:20:21 +03:00
75d24791a4 docs: improve section headings in README for better clarity 2025-06-01 11:48:30 +03:00
0dba39566f docs: fix indentation in Linear base URL note in ticket context documentation 2025-06-01 11:40:17 +03:00
Tal
d2caf0352c Merge pull request #1840 from qodo-ai/of/semi-alphabetic-tool-org
Reorganize and Enhance Tools Documentation with Improved Navigation and Consistency
2025-06-01 11:15:48 +03:00
Tal
8be2e43a0f Update README.md
Co-authored-by: qodo-merge-pro-for-open-source[bot] <189517486+qodo-merge-pro-for-open-source[bot]@users.noreply.github.com>
2025-06-01 11:15:42 +03:00
27479d87b7 docs: standardize capitalization in README table of contents and headings 2025-06-01 10:09:37 +03:00
76172bd3ec docs: add table of contents to README for improved navigation 2025-06-01 09:59:47 +03:00
Tal
4893552f20 Merge pull request #1838 from qodo-ai/hl/linear_docs
docs: add Linear integration to ticket context fetching documentation
2025-06-01 08:59:30 +03:00
520faa7f2c feat: include item count in TODO sections summary 2025-06-01 00:36:25 +09:00
d5080a35f6 docs: update Discord invitation link in README.md 2025-05-30 15:39:24 +03:00
cc06da3b7f docs: update README with improved navigation, Discord link, and table formatting 2025-05-30 15:32:01 +03:00
ac8aa9c2ef docs: reorganize tools list with consistent formatting and command names in README 2025-05-30 14:36:28 +03:00
9c1f5ad497 docs: rename "Test" to "Generate Tests" and improve tool name consistency in README 2025-05-30 14:31:46 +03:00
8baf6dba93 docs: reorganize core abilities in alphabetical order in README.md 2025-05-30 14:27:04 +03:00
403efcae22 docs: reorganize tools list in alphabetical order in README.md 2025-05-30 14:16:09 +03:00
d857132d1d docs: add Similar Code tool to documentation index and navigation 2025-05-30 14:04:45 +03:00
e7f85cf858 docs: reorganize tools documentation in alphabetical order and fix inconsistencies 2025-05-30 13:58:48 +03:00
c57f8aff9b docs: add Help Docs to the Tools list and reorganize tools documentation in alphabetical order 2025-05-30 13:35:58 +03:00
2e75fa31bd docs: add hyperlinks to ticket system integrations in fetching_ticket_context.md 2025-05-29 08:29:41 +03:00
cc1b1871d0 fix: raise Exception when arn does not exist 2025-05-29 14:06:21 +09:00
984d627300 fix: rm invalid error handling 2025-05-29 14:03:38 +09:00
d1e8d267f6 docs: detailed description 2025-05-29 13:44:33 +09:00
32b1fb91c3 chore: add comments 2025-05-29 13:17:31 +09:00
b932b96e0c docs: rm detailed document for AWS Secrets Manager 2025-05-29 13:10:18 +09:00
53e232d7f4 docs: update document for Secrets Manager 2025-05-29 13:09:58 +09:00
5e535a8868 chore: add blank 2025-05-29 13:05:40 +09:00
cd96f6b911 chore: organize comments 2025-05-29 13:03:21 +09:00
1955157e9a feat: add AWS Secrets Manager Integration 2025-05-29 12:42:05 +09:00
8143f4b35b docs: add Linear integration to ticket context fetching documentation 2025-05-28 22:23:24 +03:00
a17100e512 docs: improve clarity and formatting of review tool labels documentation 2025-05-28 19:42:27 +03:00
Tal
821227542a Merge pull request #1837 from qodo-ai/tr/docs17
docs: enhance review.md with ticket compliance labels and merge block…
2025-05-28 19:37:33 +03:00
Tal
e9ce3ae869 Update docs/docs/tools/review.md
Co-authored-by: qodo-merge-pro-for-open-source[bot] <189517486+qodo-merge-pro-for-open-source[bot]@users.noreply.github.com>
2025-05-28 19:37:23 +03:00
b4cef661e6 docs: enhance review.md with ticket compliance labels and merge blocking guidance 2025-05-28 19:35:31 +03:00
2b614330ec docs: move Installation Metrics feature from Future Plans to Recent Updates 2025-05-28 18:52:09 +03:00
8c7c087931 feat: TODO multi-line 2025-05-28 21:33:28 +09:00
b802b162d1 Merge pull request #1835 from qodo-ai/of/chat-to-implement
docs: add dedicated "Chat on code suggestions" core ability
2025-05-28 11:07:50 +03:00
fd1a27c2ac docs: add dedicated "Chat on code suggestions" core ability page and update related documentation
- Introduced a new core abilities page detailing the "Chat on code suggestions" feature, including setup, activation, and usage patterns.
- Removed the corresponding section from the improve tool documentation to avoid duplication.
- Updated the core abilities index and mkdocs navigation to include the new page.
- Improved formatting in the implement tool documentation for clarity and consistency.
2025-05-28 09:12:13 +03:00
95e4604abe test: comment out GiteaProvider unit tests and update token key for compatibility 2025-05-28 08:34:59 +03:00
Tal
d5f77560e3 Merge pull request #1811 from loolootech/feature/gitea-implement
[Feature] - Gitea implement
2025-05-28 08:22:16 +03:00
Tal
6f27fc9271 Merge pull request #1828 from Akileox/refactor-langchain-handler
Refactor: Enhance AI Handler Robustness, Interface Compliance, and Asynchronous Operations (Resolves #1784)
2025-05-28 08:20:04 +03:00
Tal
ee516ed764 Merge pull request #1831 from isExample/fix/tools-describe-docs
docs: correct parameter name typo and update description
2025-05-28 08:15:22 +03:00
Tal
9f9548395f Merge pull request #1829 from dst03106/test/add-test-for-convert-to-markdown
test: add tests for converting to markdown
2025-05-28 08:14:41 +03:00
daf6c25f9a fix: correct broken security vulnerability link in review.md documentation 2025-05-27 18:50:43 +03:00
53b913a4cb refactor: add TypedDict and type hints to todo item formatter 2025-05-27 17:52:36 +09:00
c6d6e08618 Update model references to include Claude 4 Sonnet, o4-mini and Gemini-2.5-Pro 2025-05-27 11:09:44 +03:00
Tal
5abc4028c9 Update docs/docs/overview/pr_agent_pro.md
Co-authored-by: qodo-merge-pro-for-open-source[bot] <189517486+qodo-merge-pro-for-open-source[bot]@users.noreply.github.com>
2025-05-27 11:07:27 +03:00
Tal
a540cd24e6 Update docs/docs/overview/pr_agent_pro.md
Co-authored-by: qodo-merge-pro-for-open-source[bot] <189517486+qodo-merge-pro-for-open-source[bot]@users.noreply.github.com>
2025-05-27 11:07:04 +03:00
498e5ff0a7 docs: update trial usage information to reflect new quota-based model 2025-05-27 11:04:19 +03:00
7d38814cae refactor: Change error messsage 'print' -> 'get_logger' 2025-05-27 16:51:38 +09:00
08440d8ebd feat: Add <details> to TODO sections 2025-05-27 16:19:19 +09:00
bab8ee9633 modify: ToDo -> TODO 2025-05-27 16:08:33 +09:00
495ac565b0 docs: correct parameter name typo and update description 2025-05-27 12:46:26 +09:00
82c88a1cf7 fix: improve formatting and organization of review.md documentation 2025-05-26 16:31:30 +03:00
3d5509b986 Merge remote-tracking branch 'origin/main' 2025-05-26 15:14:00 +03:00
86102abf8e fix: improve formatting of add_diagram parameter documentation in describe.md 2025-05-26 15:13:50 +03:00
df6b00aa36 test: modify test data to support multiple sub-PR themes with separate titles and relevant files 2025-05-26 16:15:16 +09:00
4baf52292d test: add tests for converting to markdown 2025-05-26 15:59:05 +09:00
e8ace9fcf9 change type check and remove useless sync 2025-05-26 14:52:45 +09:00
3ec66e6aec Change test_langchain.py 2025-05-26 14:19:46 +09:00
80b535f41a Change test_langchain.py unittest to e2e 2025-05-26 14:15:53 +09:00
Tal
805734376e Merge pull request #1825 from pr-agent-group-2/feature/fix_json_escape_char-test
Add unit tests for fix_json_escape_char function
2025-05-26 07:49:39 +03:00
Tal
a128db8393 Merge pull request #1822 from PeterDaveHelloKitchen/Gemini-2.5-Flash
Complete Gemini 2.5 Flash model info
2025-05-26 07:48:33 +03:00
Tal
9cf62e8220 Merge pull request #1819 from pr-agent-group-2/feature/wonjongin-test_get_max_tokens
Feature/test get max tokens
2025-05-26 07:48:17 +03:00
Tal
73cf69889a Merge pull request #1818 from pr-agent-group-2/feature/wonjongin-test_language_handler
fix(test_language_handler): Add edge case for files with unknown extensions
2025-05-26 07:45:11 +03:00
b18a509120 Use current 2025-05-26 11:44:39 +07:00
6063bf5978 Check is tempolary before remove it 2025-05-26 11:42:09 +07:00
5d105c64d2 Rename & Return comment object after published 2025-05-26 11:40:29 +07:00
f06ee951d7 Change raise runtime error 2025-05-26 11:36:49 +07:00
b264f42e3d Fixed handle verify signature when has failed 2025-05-26 11:31:40 +07:00
a975b32376 Get empty content when exception 2025-05-26 11:26:16 +07:00
5e9c56b96c Remove the unnecessary flag '--pr_description.final_update_message=false' 2025-05-26 11:05:58 +07:00
f78762cf2e Change the default value of is 2025-05-26 11:04:11 +07:00
4a019ba7c4 Merge branch 'main' of github.com:qodo-ai/pr-agent into feature/gitea-implement 2025-05-26 10:59:19 +07:00
16d980ec76 fix: update Mermaid diagram instructions for clarity and consistency 2025-05-25 15:38:08 +03:00
Tal
68c0fd7e3a Merge pull request #1827 from qodo-ai/tr/changes_diagram_final_touches
fix: ensure proper formatting of changes_diagram in PR description ou…
2025-05-25 15:00:23 +03:00
2eeb9b0411 fix: improve Mermaid diagram formatting and instructions in PR description template 2025-05-25 14:59:18 +03:00
f3cb4e8384 fix: ensure proper formatting of changes_diagram in PR description output 2025-05-25 14:32:12 +03:00
Tal
946657a6d1 Merge pull request #1824 from OSSCA-2025-Egg-Benedict/feature/sequence-diagram
Improve/describe tool documentation and make add_diagram feature opt-in by default
2025-05-25 13:44:53 +03:00
d2194c7ed9 docs:rename parameter ('add_diagram' -> 'enable_pr_diagram') 2025-05-25 18:39:39 +09:00
d5dead5c7f refactor: moved diagram logic to 'changes_diagram' in PRDescription and updated prompt for clarity 2025-05-25 18:37:28 +09:00
6aac41a0df refactor:rename to 2025-05-25 18:27:03 +09:00
Tal
2453508023 Merge pull request #1805 from group-3-sPRinter/improve/token_handler
Refactor count_tokens method structure in token_handler.py for better extensibility
2025-05-25 12:11:41 +03:00
84f2f4fe3d Fix: use ModelTypeValidator static methods directly 2025-05-25 18:00:38 +09:00
aa3e5b79c8 docs:apply proper formatting to documentation 2025-05-25 17:55:14 +09:00
d9f64e52e4 Refactor LangChain AI Handler for Async and Performance
- Add async LLM object creation and invocation
- Branch parameter handling by LLM type
- Enhance error logging and handler consistency
- Add performance and concurrency test code
2025-05-25 15:34:51 +09:00
ff52ae9281 add img_path and _create_chat_async 2025-05-25 15:34:50 +09:00
d791e9f3d1 Fix: Improve langchain import error handling and add img_path to handler
Addresses issue #1784:
- Raises ImportError if langchain is not installed when LangChainOpenAIHandler is initialized.
- Adds img_path parameter to LangChainOpenAIHandler.chat_completion for interface consistency.
- Logs a warning if img_path is used with LangChainOpenAIHandler.
2025-05-25 15:28:18 +09:00
2afc3d3437 test: add test cases for fix_json_escape_char function 2025-05-25 15:21:19 +09:00
Tal
511f1ba6ae Merge pull request #1823 from qodo-ai/tr/ensure_ticket_compliance
ensure_ticket_compliance
2025-05-25 08:43:04 +03:00
Tal
415817b421 Update docs/docs/tools/improve.md
Co-authored-by: qodo-merge-pro-for-open-source[bot] <189517486+qodo-merge-pro-for-open-source[bot]@users.noreply.github.com>
2025-05-25 08:42:55 +03:00
18a8a741fa ensure_ticket_compliance 2025-05-25 08:31:24 +03:00
113229b218 Merge pull request #6 from OSSCA-2025-Egg-Benedict/jihan
refactor: reorder and clarify describe tool docs, enforce opt-in default for add_diagram
2025-05-25 14:30:00 +09:00
Tal
4cdaad1fc5 Merge pull request #1816 from TaskerJang/feature/clip-tokens-tests-and-docs
Add Unit Tests and Improve Documentation for utils.py clip_tokens Function
2025-05-25 08:18:26 +03:00
e57d3101e4 fix:set parameter default to false to make the feature opt-in by design 2025-05-25 12:48:29 +09:00
f58c40a6ae refactor: replace single quotes with double quotes to match existing code style 2025-05-25 12:48:13 +09:00
c346d784e3 docs:move sequence diagram section below main explanation of describe 2025-05-25 12:47:09 +09:00
32460fac57 Merge pull request #3 from OSSCA-2025-Egg-Benedict/donguk
add docs about Mermaid Diagram
2025-05-25 12:26:05 +09:00
d8aa61622f Merge pull request #5 from OSSCA-2025-Egg-Benedict/yeji
feat: conditionally append Mermaid sequence diagram instruction in prompt
2025-05-25 12:15:01 +09:00
2b2818a435 Merge pull request #4 from OSSCA-2025-Egg-Benedict/seonwoong
feat: add add_diagram configuration option to PR description
2025-05-25 12:13:50 +09:00
cdca5a55b2 Merge pull request #2 from OSSCA-2025-Egg-Benedict/yujin
feat: add add_diagram flag in configuration.toml
2025-05-25 12:06:31 +09:00
9f9397b2d8 Merge pull request #1 from OSSCA-2025-Egg-Benedict/gahee
feat: conditionally include diagram in output example
2025-05-25 12:06:02 +09:00
3a385b62d6 feat: conditionally append Mermaid sequence diagram instruction in pr_description prompt 2025-05-25 11:51:22 +09:00
94e1126b00 add docs about Mermaid Diagram 2025-05-25 11:09:11 +09:00
5a0affd6cb feat: add add_diagram configuration option to PR description 2025-05-25 11:08:52 +09:00
d62cbb2fc4 feat: add add_diagram flag in configuration.toml 2025-05-25 10:28:50 +09:00
f5bb508736 fix: use identity check for None comparison in clip_tokens tests
- Replace `== None` with `is None` in test_empty_input_text method
- Follow Python best practice for None comparisons as recommended in code review
- Address feedback from PR #1816 review comment

Co-authored-by: mrT23
2025-05-25 07:55:18 +09:00
4047e71268 Complete Gemini 2.5 Flash model info 2025-05-24 23:52:18 +08:00
ca3df352ab refactor: improve todo section handling and clarify todo content description 2025-05-25 00:02:21 +09:00
16b9ccd025 feat: conditionally include diagram in output example 2025-05-24 23:43:16 +09:00
Tal
43dbe24a7f Merge pull request #1817 from PeterDaveHelloKitchen/Grok-3
Add Grok-3 non-beta model IDs
2025-05-24 16:32:50 +03:00
Tal
f4a9bc3de7 Merge pull request #1814 from hirobf10/support-claude-4
feat: add support for Claude 4 family
2025-05-24 16:29:48 +03:00
Tal
ad4721f55b Merge pull request #1812 from pr-agent-group-2/feature/try_fix_yaml-test
Add unit tests for try_fix_yaml function
2025-05-24 16:25:58 +03:00
Tal
20b1a1f552 Merge pull request #1808 from group-3-sPRinter/fix/retry-exclude-rate-limit-error
fix: exclude RateLimitError from `@retry` in `AIHandler.chat_completion()`
2025-05-24 16:14:25 +03:00
Tal
4c98cffd37 Merge pull request #1801 from darkdread/main
docs: include [aws] in .secrets.template
2025-05-24 16:12:52 +03:00
Tal
453f8e19f3 Update docs/docs/usage-guide/changing_a_model.md
Co-authored-by: qodo-merge-pro-for-open-source[bot] <189517486+qodo-merge-pro-for-open-source[bot]@users.noreply.github.com>
2025-05-24 16:12:37 +03:00
b83085ea00 fix: remove whitespace from relevant file 2025-05-24 22:01:29 +09:00
95c94b80a2 Add Grok-3 non-beta model IDs 2025-05-24 14:22:55 +08:00
e2586cb64a docs: improve clip_tokens function docstring and add examples 2025-05-24 10:46:58 +09:00
1bc0d488d5 test: add comprehensive unit tests for clip_tokens function
- Add 21 test cases covering edge cases and parameter combinations
- Include tests for Unicode, special characters, and long text
  processing
- Verify exception handling and backward compatibility
2025-05-24 10:44:55 +09:00
1f836e405d fix: reflect comments 2025-05-24 09:45:27 +09:00
66131854c1 fix: avoid incorrect ToDo header 2025-05-24 03:04:59 +09:00
788c0c12e6 feat: add TODO comments to PR review output 2025-05-24 01:52:52 +09:00
c4358d1ca0 chore: update the version of litellm to 1.70.4 2025-05-23 19:18:09 +09:00
c10be827a1 chore: update the version of anthropic sdk 2025-05-23 14:23:51 +09:00
10703a9098 feat: add support for Claude 4 2025-05-23 14:16:44 +09:00
162cc9d833 Fixed error propagation 2025-05-22 15:06:35 +07:00
0f893bc492 Fixed webhook security concern 2025-05-22 15:03:15 +07:00
000f0ba93e Fixed ensure SHA 2025-05-22 15:01:08 +07:00
48c29c9ffa Add null check 2025-05-22 14:59:29 +07:00
f6a9d3c2cc fix:typo in test_with_initial_yaml, test_no_initial_yaml 2025-05-22 16:55:52 +09:00
930cd69909 Fixed conflicts 2025-05-22 14:54:26 +07:00
684a438167 test: add test case for fixing incorrect indentation in YAML code block scalar 2025-05-22 16:53:02 +09:00
f10c389406 test: add test cases for YAML block scalar with inconsistent and insufficient indentation 2025-05-22 16:53:02 +09:00
20e69c3530 test: add test case for YAML block scalar with leading plus signs in code 2025-05-22 16:53:02 +09:00
069f36fc1f test: add test case for YAML with tab indentation in block scalar 2025-05-22 16:53:02 +09:00
1c6958069a test/wonjongin-text_get_max_tokens code generate
- There is no test code for get_max_tokens of utils, so the unit test code related to the part corresponding to each test branch is added
2025-05-22 16:32:04 +09:00
e79c34e039 test: add test case for YAML wrapped with braces 2025-05-22 16:27:38 +09:00
Tal
e045617243 Merge pull request #1809 from qodo-ai/mrT23-patch-12
Update LICENSE
2025-05-22 10:06:13 +03:00
Tal
70428ebb21 Update LICENSE 2025-05-22 10:01:52 +03:00
466ec4ce90 fix: exclude RateLimitError from retry logic 2025-05-22 15:04:16 +09:00
facfb5f46b Add missing code: use_context=False 2025-05-22 13:32:20 +09:00
cc686ef26d Reorder model check: OpenAI before Anthropic
OpenAI is the default in most cases, so checking it first skips unnecessary Anthropic logic.
2025-05-22 13:12:04 +09:00
ead7491ca9 Apply convention for marking private 2025-05-21 18:08:48 +09:00
df0355d827 Remove member variable for restroring get_settings() 2025-05-21 18:07:47 +09:00
c3ea048b71 Restore original return logic for force_accurate condition 2025-05-21 17:52:51 +09:00
648829b770 Rename method 2025-05-21 17:51:03 +09:00
4e80f3999c Merge remote-tracking branch 'origin/main' 2025-05-21 07:53:42 +03:00
3bced45248 docs: improve configuration options documentation with clearer formatting and links 2025-05-21 07:53:31 +03:00
Tal
dd17aadfe3 Merge pull request #1803 from group-3-sPRinter/fix/litellm-exception-order
fix: reorder exception handling in `LiteLLMAIHandler.chat_completion()`
2025-05-21 07:42:18 +03:00
Tal
199b463eaa Merge pull request #1798 from seohyun-lee/docs/usage-guide
Correct typos in documentation and log messages
2025-05-21 07:38:22 +03:00
Tal
7821e71b17 Merge pull request #1787 from nicholasgribanov/feature/gitea-forgejo-support
#1657 add gitea/forgejo support
2025-05-21 07:35:31 +03:00
b686a707a4 Not implement online 2025-05-20 16:54:20 +07:00
bd68a0de55 Update Gitea documents 2025-05-20 16:46:32 +07:00
6405284461 fix: reorder exception handling to enable proper retry behavior 2025-05-20 18:22:33 +09:00
9069c37a05 Add incremental update to documentation (#1796) 2025-05-20 12:12:06 +03:00
2d619564f2 Update README for Gitea 2025-05-20 15:51:50 +07:00
1b74942919 Set default configuration of Gitea 2025-05-20 15:18:07 +07:00
97f2b6f736 Fix TypeError 2025-05-20 15:29:27 +09:00
eecf115b91 Merge pull request #1799 from seohyun-lee/docs/review
Revise the review effort label text in the review document
2025-05-20 08:28:38 +03:00
f198e6fa09 Add constants and improve token calculation logic 2025-05-20 14:12:24 +09:00
e72bb28c4e Replace get_settings() with self.settings 2025-05-20 13:50:30 +09:00
81fa22e4df Add model name validation 2025-05-20 13:47:15 +09:00
8aa89ff8e6 docs: include [aws] in .secrets.template 2025-05-20 10:27:13 +08:00
Tal
6d9bb93f62 Merge pull request #1795 from jmsb02/docs/add_docs-auto-trigger-docs-only
docs: document how to auto-trigger /add_docs via pr_commands
2025-05-19 21:30:05 +03:00
25b807f71c docs: Add missing spacebar 2025-05-20 03:11:21 +09:00
03fa5b7d92 docs: Modify the review effort label text in the review document to an updated format 2025-05-20 03:00:54 +09:00
4679dce3af refactor: Correct case typo of PR in log 2025-05-20 02:31:48 +09:00
94aa8e8638 refactor: Correct case typo in log 2025-05-20 02:30:17 +09:00
f5a069d6b4 refactor: Align comment formatting with others 2025-05-20 02:28:43 +09:00
2a42d009af docs: Fix broken Markdown code block in Installation documentation 2025-05-20 02:27:14 +09:00
Tal
9464fd9696 Merge pull request #1797 from GuBee33/main
Adding num_max_findings configuration parameter
2025-05-19 20:23:14 +03:00
95df26c973 docs: Correct typos in ignore section configuration 2025-05-20 02:08:41 +09:00
a315779713 docs: document how to auto-trigger /add_docs via pr_commands 2025-05-20 00:23:44 +09:00
c97b49c373 typo fix 2025-05-19 16:19:41 +02:00
5a8ce252f7 Adding num_max_findings configuration parameter with a default value of 3, to have the possibility to extend it 2025-05-19 16:16:23 +02:00
5e40b3962a docs: document how to auto-trigger /add_docs via pr_commands 2025-05-19 22:22:22 +09:00
3f4fac1232 docs: document how to auto-trigger /add_docs via pr_commands 2025-05-19 21:17:59 +09:00
e692dee66a docs: document how to auto-trigger /add_docs via pr_commands 2025-05-19 17:39:55 +09:00
31620a82c0 docs: document how to auto-trigger /add_docs via pr_commands 2025-05-19 17:36:54 +09:00
2dbcb3e5dc docs: improve configuration options documentation with better formatting and links 2025-05-19 11:01:14 +03:00
74b4488c7e fix/wonjongin-test_language_handler - test_edge_case_languages_with_no_extensions code modification
- Since the existing code did not meet the requirements of the test, test is conducted on the assumption of a separate file name that does not exist in the extension
2025-05-19 16:44:22 +09:00
Tal
65d9269bf2 Merge pull request #1790 from qodo-ai/tr/v_029
Tr/v029
2025-05-17 21:08:41 +03:00
411245155f docs: update README and Dockerfile with v0.29 release information 2025-05-17 21:05:22 +03:00
14fb98aa77 docs: update README and recent updates page with v0.29 release information 2025-05-17 21:03:29 +03:00
b4ae07bf82 Remove test case for YAML parsing that removes last line 2025-05-17 20:58:32 +03:00
d67d07acc7 #1657 review fix 2 2025-05-16 20:30:17 +03:00
12b1fe23da #1657 review fix 2025-05-16 20:12:40 +03:00
f857ea1f22 #1657 add gitea/forgejo support 2025-05-16 19:43:21 +03:00
8b1abbcc2c Add lib dependency 2025-05-16 16:34:53 +07:00
a692a70027 Implement for docker 2025-05-16 16:34:11 +07:00
fab8573c4d Set default configuration 2025-05-16 16:33:36 +07:00
2d7636543c Implement provider 2025-05-16 16:31:49 +07:00
cf2b95b766 Create webhook server implement for 2025-05-16 16:30:50 +07:00
9ef0c451bf Create provider module for 2025-05-16 16:30:10 +07:00
05ab5f699f Improve token calculation logic based on model type
- Rename calc_tokens to get_token_count_by_model_type for clearer intent
- Separate model type detection logic to improve maintainability
2025-05-16 17:51:22 +09:00
99 changed files with 5935 additions and 981 deletions

797
LICENSE
View File

@ -1,202 +1,661 @@
GNU AFFERO GENERAL PUBLIC LICENSE
Version 3, 19 November 2007
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
Preamble
1. Definitions.
The GNU Affero General Public License is a free, copyleft license for
software and other kinds of works, specifically designed to ensure
cooperation with the community in the case of network server software.
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
The licenses for most software and other practical works are designed
to take away your freedom to share and change the works. By contrast,
our General Public Licenses are intended to guarantee your freedom to
share and change all versions of a program--to make sure it remains free
software for all its users.
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
When we speak of free software, we are referring to freedom, not
price. Our General Public Licenses are designed to make sure that you
have the freedom to distribute copies of free software (and charge for
them if you wish), that you receive source code or can get it if you
want it, that you can change the software or use pieces of it in new
free programs, and that you know you can do these things.
"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
Developers that use our General Public Licenses protect your rights
with two steps: (1) assert copyright on the software, and (2) offer
you this License which gives you legal permission to copy, distribute
and/or modify the software.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
A secondary benefit of defending all users' freedom is that
improvements made in alternate versions of the program, if they
receive widespread use, become available for other developers to
incorporate. Many developers of free software are heartened and
encouraged by the resulting cooperation. However, in the case of
software used on network servers, this result may fail to come about.
The GNU General Public License permits making a modified version and
letting the public access it on a server without ever releasing its
source code to the public.
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
The GNU Affero General Public License is designed specifically to
ensure that, in such cases, the modified source code becomes available
to the community. It requires the operator of a network server to
provide the source code of the modified version running there to the
users of that server. Therefore, public use of a modified version, on
a publicly accessible server, gives the public access to the source
code of the modified version.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
An older license, called the Affero General Public License and
published by Affero, was designed to accomplish similar goals. This is
a different license, not a version of the Affero GPL, but Affero has
released a new version of the Affero GPL which permits relicensing under
this license.
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
The precise terms and conditions for copying, distribution and
modification follow.
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
TERMS AND CONDITIONS
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
0. Definitions.
"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
"This License" refers to version 3 of the GNU Affero General Public License.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
"Copyright" also means copyright-like laws that apply to other kinds of
works, such as semiconductor masks.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
"The Program" refers to any copyrightable work licensed under this
License. Each licensee is addressed as "you". "Licensees" and
"recipients" may be individuals or organizations.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
To "modify" a work means to copy from or adapt all or part of the work
in a fashion requiring copyright permission, other than the making of an
exact copy. The resulting work is called a "modified version" of the
earlier work or a work "based on" the earlier work.
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
A "covered work" means either the unmodified Program or a work based
on the Program.
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
To "propagate" a work means to do anything with it that, without
permission, would make you directly or secondarily liable for
infringement under applicable copyright law, except executing it on a
computer or modifying a private copy. Propagation includes copying,
distribution (with or without modification), making available to the
public, and in some countries other activities as well.
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
To "convey" a work means any kind of propagation that enables other
parties to make or receive copies. Mere interaction with a user through
a computer network, with no transfer of a copy, is not conveying.
(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
An interactive user interface displays "Appropriate Legal Notices"
to the extent that it includes a convenient and prominently visible
feature that (1) displays an appropriate copyright notice, and (2)
tells the user that there is no warranty for the work (except to the
extent that warranties are provided), that licensees may convey the
work under this License, and how to view a copy of this License. If
the interface presents a list of user commands or options, such as a
menu, a prominent item in the list meets this criterion.
You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
1. Source Code.
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
The "source code" for a work means the preferred form of the work
for making modifications to it. "Object code" means any non-source
form of a work.
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
A "Standard Interface" means an interface that either is an official
standard defined by a recognized standards body, or, in the case of
interfaces specified for a particular programming language, one that
is widely used among developers working in that language.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
The "System Libraries" of an executable work include anything, other
than the work as a whole, that (a) is included in the normal form of
packaging a Major Component, but which is not part of that Major
Component, and (b) serves only to enable use of the work with that
Major Component, or to implement a Standard Interface for which an
implementation is available to the public in source code form. A
"Major Component", in this context, means a major essential component
(kernel, window system, and so on) of the specific operating system
(if any) on which the executable work runs, or a compiler used to
produce the work, or an object code interpreter used to run it.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
The "Corresponding Source" for a work in object code form means all
the source code needed to generate, install, and (for an executable
work) run the object code and to modify the work, including scripts to
control those activities. However, it does not include the work's
System Libraries, or general-purpose tools or generally available free
programs which are used unmodified in performing those activities but
which are not part of the work. For example, Corresponding Source
includes interface definition files associated with source files for
the work, and the source code for shared libraries and dynamically
linked subprograms that the work is specifically designed to require,
such as by intimate data communication or control flow between those
subprograms and other parts of the work.
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.
The Corresponding Source need not include anything that users
can regenerate automatically from other parts of the Corresponding
Source.
END OF TERMS AND CONDITIONS
The Corresponding Source for a work in source code form is that
same work.
APPENDIX: How to apply the Apache License to your work.
2. Basic Permissions.
To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.
All rights granted under this License are granted for the term of
copyright on the Program, and are irrevocable provided the stated
conditions are met. This License explicitly affirms your unlimited
permission to run the unmodified Program. The output from running a
covered work is covered by this License only if the output, given its
content, constitutes a covered work. This License acknowledges your
rights of fair use or other equivalent, as provided by copyright law.
Copyright [2023] [Codium ltd]
You may make, run and propagate covered works that you do not
convey, without conditions so long as your license otherwise remains
in force. You may convey covered works to others for the sole purpose
of having them make modifications exclusively for you, or provide you
with facilities for running those works, provided that you comply with
the terms of this License in conveying all material for which you do
not control copyright. Those thus making or running the covered works
for you must do so exclusively on your behalf, under your direction
and control, on terms that prohibit them from making any copies of
your copyrighted material outside their relationship with you.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
Conveying under any other circumstances is permitted solely under
the conditions stated below. Sublicensing is not allowed; section 10
makes it unnecessary.
http://www.apache.org/licenses/LICENSE-2.0
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
Unless required by applicable law or agreed to in writing, software
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.
No covered work shall be deemed part of an effective technological
measure under any applicable law fulfilling obligations under article
11 of the WIPO copyright treaty adopted on 20 December 1996, or
similar laws prohibiting or restricting circumvention of such
measures.
When you convey a covered work, you waive any legal power to forbid
circumvention of technological measures to the extent such circumvention
is effected by exercising rights under this License with respect to
the covered work, and you disclaim any intention to limit operation or
modification of the work as a means of enforcing, against the work's
users, your or third parties' legal rights to forbid circumvention of
technological measures.
4. Conveying Verbatim Copies.
You may convey verbatim copies of the Program's source code as you
receive it, in any medium, provided that you conspicuously and
appropriately publish on each copy an appropriate copyright notice;
keep intact all notices stating that this License and any
non-permissive terms added in accord with section 7 apply to the code;
keep intact all notices of the absence of any warranty; and give all
recipients a copy of this License along with the Program.
You may charge any price or no price for each copy that you convey,
and you may offer support or warranty protection for a fee.
5. Conveying Modified Source Versions.
You may convey a work based on the Program, or the modifications to
produce it from the Program, in the form of source code under the
terms of section 4, provided that you also meet all of these conditions:
a) The work must carry prominent notices stating that you modified
it, and giving a relevant date.
b) The work must carry prominent notices stating that it is
released under this License and any conditions added under section
7. This requirement modifies the requirement in section 4 to
"keep intact all notices".
c) You must license the entire work, as a whole, under this
License to anyone who comes into possession of a copy. This
License will therefore apply, along with any applicable section 7
additional terms, to the whole of the work, and all its parts,
regardless of how they are packaged. This License gives no
permission to license the work in any other way, but it does not
invalidate such permission if you have separately received it.
d) If the work has interactive user interfaces, each must display
Appropriate Legal Notices; however, if the Program has interactive
interfaces that do not display Appropriate Legal Notices, your
work need not make them do so.
A compilation of a covered work with other separate and independent
works, which are not by their nature extensions of the covered work,
and which are not combined with it such as to form a larger program,
in or on a volume of a storage or distribution medium, is called an
"aggregate" if the compilation and its resulting copyright are not
used to limit the access or legal rights of the compilation's users
beyond what the individual works permit. Inclusion of a covered work
in an aggregate does not cause this License to apply to the other
parts of the aggregate.
6. Conveying Non-Source Forms.
You may convey a covered work in object code form under the terms
of sections 4 and 5, provided that you also convey the
machine-readable Corresponding Source under the terms of this License,
in one of these ways:
a) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by the
Corresponding Source fixed on a durable physical medium
customarily used for software interchange.
b) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by a
written offer, valid for at least three years and valid for as
long as you offer spare parts or customer support for that product
model, to give anyone who possesses the object code either (1) a
copy of the Corresponding Source for all the software in the
product that is covered by this License, on a durable physical
medium customarily used for software interchange, for a price no
more than your reasonable cost of physically performing this
conveying of source, or (2) access to copy the
Corresponding Source from a network server at no charge.
c) Convey individual copies of the object code with a copy of the
written offer to provide the Corresponding Source. This
alternative is allowed only occasionally and noncommercially, and
only if you received the object code with such an offer, in accord
with subsection 6b.
d) Convey the object code by offering access from a designated
place (gratis or for a charge), and offer equivalent access to the
Corresponding Source in the same way through the same place at no
further charge. You need not require recipients to copy the
Corresponding Source along with the object code. If the place to
copy the object code is a network server, the Corresponding Source
may be on a different server (operated by you or a third party)
that supports equivalent copying facilities, provided you maintain
clear directions next to the object code saying where to find the
Corresponding Source. Regardless of what server hosts the
Corresponding Source, you remain obligated to ensure that it is
available for as long as needed to satisfy these requirements.
e) Convey the object code using peer-to-peer transmission, provided
you inform other peers where the object code and Corresponding
Source of the work are being offered to the general public at no
charge under subsection 6d.
A separable portion of the object code, whose source code is excluded
from the Corresponding Source as a System Library, need not be
included in conveying the object code work.
A "User Product" is either (1) a "consumer product", which means any
tangible personal property which is normally used for personal, family,
or household purposes, or (2) anything designed or sold for incorporation
into a dwelling. In determining whether a product is a consumer product,
doubtful cases shall be resolved in favor of coverage. For a particular
product received by a particular user, "normally used" refers to a
typical or common use of that class of product, regardless of the status
of the particular user or of the way in which the particular user
actually uses, or expects or is expected to use, the product. A product
is a consumer product regardless of whether the product has substantial
commercial, industrial or non-consumer uses, unless such uses represent
the only significant mode of use of the product.
"Installation Information" for a User Product means any methods,
procedures, authorization keys, or other information required to install
and execute modified versions of a covered work in that User Product from
a modified version of its Corresponding Source. The information must
suffice to ensure that the continued functioning of the modified object
code is in no case prevented or interfered with solely because
modification has been made.
If you convey an object code work under this section in, or with, or
specifically for use in, a User Product, and the conveying occurs as
part of a transaction in which the right of possession and use of the
User Product is transferred to the recipient in perpetuity or for a
fixed term (regardless of how the transaction is characterized), the
Corresponding Source conveyed under this section must be accompanied
by the Installation Information. But this requirement does not apply
if neither you nor any third party retains the ability to install
modified object code on the User Product (for example, the work has
been installed in ROM).
The requirement to provide Installation Information does not include a
requirement to continue to provide support service, warranty, or updates
for a work that has been modified or installed by the recipient, or for
the User Product in which it has been modified or installed. Access to a
network may be denied when the modification itself materially and
adversely affects the operation of the network or violates the rules and
protocols for communication across the network.
Corresponding Source conveyed, and Installation Information provided,
in accord with this section must be in a format that is publicly
documented (and with an implementation available to the public in
source code form), and must require no special password or key for
unpacking, reading or copying.
7. Additional Terms.
"Additional permissions" are terms that supplement the terms of this
License by making exceptions from one or more of its conditions.
Additional permissions that are applicable to the entire Program shall
be treated as though they were included in this License, to the extent
that they are valid under applicable law. If additional permissions
apply only to part of the Program, that part may be used separately
under those permissions, but the entire Program remains governed by
this License without regard to the additional permissions.
When you convey a copy of a covered work, you may at your option
remove any additional permissions from that copy, or from any part of
it. (Additional permissions may be written to require their own
removal in certain cases when you modify the work.) You may place
additional permissions on material, added by you to a covered work,
for which you have or can give appropriate copyright permission.
Notwithstanding any other provision of this License, for material you
add to a covered work, you may (if authorized by the copyright holders of
that material) supplement the terms of this License with terms:
a) Disclaiming warranty or limiting liability differently from the
terms of sections 15 and 16 of this License; or
b) Requiring preservation of specified reasonable legal notices or
author attributions in that material or in the Appropriate Legal
Notices displayed by works containing it; or
c) Prohibiting misrepresentation of the origin of that material, or
requiring that modified versions of such material be marked in
reasonable ways as different from the original version; or
d) Limiting the use for publicity purposes of names of licensors or
authors of the material; or
e) Declining to grant rights under trademark law for use of some
trade names, trademarks, or service marks; or
f) Requiring indemnification of licensors and authors of that
material by anyone who conveys the material (or modified versions of
it) with contractual assumptions of liability to the recipient, for
any liability that these contractual assumptions directly impose on
those licensors and authors.
All other non-permissive additional terms are considered "further
restrictions" within the meaning of section 10. If the Program as you
received it, or any part of it, contains a notice stating that it is
governed by this License along with a term that is a further
restriction, you may remove that term. If a license document contains
a further restriction but permits relicensing or conveying under this
License, you may add to a covered work material governed by the terms
of that license document, provided that the further restriction does
not survive such relicensing or conveying.
If you add terms to a covered work in accord with this section, you
must place, in the relevant source files, a statement of the
additional terms that apply to those files, or a notice indicating
where to find the applicable terms.
Additional terms, permissive or non-permissive, may be stated in the
form of a separately written license, or stated as exceptions;
the above requirements apply either way.
8. Termination.
You may not propagate or modify a covered work except as expressly
provided under this License. Any attempt otherwise to propagate or
modify it is void, and will automatically terminate your rights under
this License (including any patent licenses granted under the third
paragraph of section 11).
However, if you cease all violation of this License, then your
license from a particular copyright holder is reinstated (a)
provisionally, unless and until the copyright holder explicitly and
finally terminates your license, and (b) permanently, if the copyright
holder fails to notify you of the violation by some reasonable means
prior to 60 days after the cessation.
Moreover, your license from a particular copyright holder is
reinstated permanently if the copyright holder notifies you of the
violation by some reasonable means, this is the first time you have
received notice of violation of this License (for any work) from that
copyright holder, and you cure the violation prior to 30 days after
your receipt of the notice.
Termination of your rights under this section does not terminate the
licenses of parties who have received copies or rights from you under
this License. If your rights have been terminated and not permanently
reinstated, you do not qualify to receive new licenses for the same
material under section 10.
9. Acceptance Not Required for Having Copies.
You are not required to accept this License in order to receive or
run a copy of the Program. Ancillary propagation of a covered work
occurring solely as a consequence of using peer-to-peer transmission
to receive a copy likewise does not require acceptance. However,
nothing other than this License grants you permission to propagate or
modify any covered work. These actions infringe copyright if you do
not accept this License. Therefore, by modifying or propagating a
covered work, you indicate your acceptance of this License to do so.
10. Automatic Licensing of Downstream Recipients.
Each time you convey a covered work, the recipient automatically
receives a license from the original licensors, to run, modify and
propagate that work, subject to this License. You are not responsible
for enforcing compliance by third parties with this License.
An "entity transaction" is a transaction transferring control of an
organization, or substantially all assets of one, or subdividing an
organization, or merging organizations. If propagation of a covered
work results from an entity transaction, each party to that
transaction who receives a copy of the work also receives whatever
licenses to the work the party's predecessor in interest had or could
give under the previous paragraph, plus a right to possession of the
Corresponding Source of the work from the predecessor in interest, if
the predecessor has it or can get it with reasonable efforts.
You may not impose any further restrictions on the exercise of the
rights granted or affirmed under this License. For example, you may
not impose a license fee, royalty, or other charge for exercise of
rights granted under this License, and you may not initiate litigation
(including a cross-claim or counterclaim in a lawsuit) alleging that
any patent claim is infringed by making, using, selling, offering for
sale, or importing the Program or any portion of it.
11. Patents.
A "contributor" is a copyright holder who authorizes use under this
License of the Program or a work on which the Program is based. The
work thus licensed is called the contributor's "contributor version".
A contributor's "essential patent claims" are all patent claims
owned or controlled by the contributor, whether already acquired or
hereafter acquired, that would be infringed by some manner, permitted
by this License, of making, using, or selling its contributor version,
but do not include claims that would be infringed only as a
consequence of further modification of the contributor version. For
purposes of this definition, "control" includes the right to grant
patent sublicenses in a manner consistent with the requirements of
this License.
Each contributor grants you a non-exclusive, worldwide, royalty-free
patent license under the contributor's essential patent claims, to
make, use, sell, offer for sale, import and otherwise run, modify and
propagate the contents of its contributor version.
In the following three paragraphs, a "patent license" is any express
agreement or commitment, however denominated, not to enforce a patent
(such as an express permission to practice a patent or covenant not to
sue for patent infringement). To "grant" such a patent license to a
party means to make such an agreement or commitment not to enforce a
patent against the party.
If you convey a covered work, knowingly relying on a patent license,
and the Corresponding Source of the work is not available for anyone
to copy, free of charge and under the terms of this License, through a
publicly available network server or other readily accessible means,
then you must either (1) cause the Corresponding Source to be so
available, or (2) arrange to deprive yourself of the benefit of the
patent license for this particular work, or (3) arrange, in a manner
consistent with the requirements of this License, to extend the patent
license to downstream recipients. "Knowingly relying" means you have
actual knowledge that, but for the patent license, your conveying the
covered work in a country, or your recipient's use of the covered work
in a country, would infringe one or more identifiable patents in that
country that you have reason to believe are valid.
If, pursuant to or in connection with a single transaction or
arrangement, you convey, or propagate by procuring conveyance of, a
covered work, and grant a patent license to some of the parties
receiving the covered work authorizing them to use, propagate, modify
or convey a specific copy of the covered work, then the patent license
you grant is automatically extended to all recipients of the covered
work and works based on it.
A patent license is "discriminatory" if it does not include within
the scope of its coverage, prohibits the exercise of, or is
conditioned on the non-exercise of one or more of the rights that are
specifically granted under this License. You may not convey a covered
work if you are a party to an arrangement with a third party that is
in the business of distributing software, under which you make payment
to the third party based on the extent of your activity of conveying
the work, and under which the third party grants, to any of the
parties who would receive the covered work from you, a discriminatory
patent license (a) in connection with copies of the covered work
conveyed by you (or copies made from those copies), or (b) primarily
for and in connection with specific products or compilations that
contain the covered work, unless you entered into that arrangement,
or that patent license was granted, prior to 28 March 2007.
Nothing in this License shall be construed as excluding or limiting
any implied license or other defenses to infringement that may
otherwise be available to you under applicable patent law.
12. No Surrender of Others' Freedom.
If conditions are imposed on you (whether by court order, agreement or
otherwise) that contradict the conditions of this License, they do not
excuse you from the conditions of this License. If you cannot convey a
covered work so as to satisfy simultaneously your obligations under this
License and any other pertinent obligations, then as a consequence you may
not convey it at all. For example, if you agree to terms that obligate you
to collect a royalty for further conveying from those to whom you convey
the Program, the only way you could satisfy both those terms and this
License would be to refrain entirely from conveying the Program.
13. Remote Network Interaction; Use with the GNU General Public License.
Notwithstanding any other provision of this License, if you modify the
Program, your modified version must prominently offer all users
interacting with it remotely through a computer network (if your version
supports such interaction) an opportunity to receive the Corresponding
Source of your version by providing access to the Corresponding Source
from a network server at no charge, through some standard or customary
means of facilitating copying of software. This Corresponding Source
shall include the Corresponding Source for any work covered by version 3
of the GNU General Public License that is incorporated pursuant to the
following paragraph.
Notwithstanding any other provision of this License, you have
permission to link or combine any covered work with a work licensed
under version 3 of the GNU General Public License into a single
combined work, and to convey the resulting work. The terms of this
License will continue to apply to the part which is the covered work,
but the work with which it is combined will remain governed by version
3 of the GNU General Public License.
14. Revised Versions of this License.
The Free Software Foundation may publish revised and/or new versions of
the GNU Affero General Public License from time to time. Such new versions
will be similar in spirit to the present version, but may differ in detail to
address new problems or concerns.
Each version is given a distinguishing version number. If the
Program specifies that a certain numbered version of the GNU Affero General
Public License "or any later version" applies to it, you have the
option of following the terms and conditions either of that numbered
version or of any later version published by the Free Software
Foundation. If the Program does not specify a version number of the
GNU Affero General Public License, you may choose any version ever published
by the Free Software Foundation.
If the Program specifies that a proxy can decide which future
versions of the GNU Affero General Public License can be used, that proxy's
public statement of acceptance of a version permanently authorizes you
to choose that version for the Program.
Later license versions may give you additional or different
permissions. However, no additional obligations are imposed on any
author or copyright holder as a result of your choosing to follow a
later version.
15. Disclaimer of Warranty.
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
16. Limitation of Liability.
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
SUCH DAMAGES.
17. Interpretation of Sections 15 and 16.
If the disclaimer of warranty and limitation of liability provided
above cannot be given local legal effect according to their terms,
reviewing courts shall apply local law that most closely approximates
an absolute waiver of all civil liability in connection with the
Program, unless a warranty or assumption of liability accompanies a
copy of the Program in return for a fee.
END OF TERMS AND CONDITIONS
How to Apply These Terms to Your New Programs
If you develop a new program, and you want it to be of the greatest
possible use to the public, the best way to achieve this is to make it
free software which everyone can redistribute and change under these terms.
To do so, attach the following notices to the program. It is safest
to attach them to the start of each source file to most effectively
state the exclusion of warranty; and each file should have at least
the "copyright" line and a pointer to where the full notice is found.
<one line to give the program's name and a brief idea of what it does.>
Copyright (C) <year> <name of author>
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as published
by the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License
along with this program. If not, see <https://www.gnu.org/licenses/>.
Also add information on how to contact you by electronic and paper mail.
If your software can interact with users remotely through a computer
network, you should also make sure that it provides a way for users to
get its source. For example, if your program is a web application, its
interface could display a "Source" link that leads users to an archive
of the code. There are many ways you could offer source, and different
solutions will be better for different programs; see section 13 for the
specific requirements.
You should also get your employer (if you work as a programmer) or school,
if any, to sign a "copyright disclaimer" for the program, if necessary.
For more information on this, and how to apply and follow the GNU AGPL, see
<https://www.gnu.org/licenses/>.

214
README.md
View File

@ -27,32 +27,64 @@ PR-Agent aims to help efficiently review and handle pull requests, by providing
</a>
</div>
[//]: # (### [Documentation]&#40;https://qodo-merge-docs.qodo.ai/&#41;)
[//]: # ()
[//]: # (- See the [Installation Guide]&#40;https://qodo-merge-docs.qodo.ai/installation/&#41; for instructions on installing PR-Agent on different platforms.)
[//]: # ()
[//]: # (- See the [Usage Guide]&#40;https://qodo-merge-docs.qodo.ai/usage-guide/&#41; for instructions on running PR-Agent tools via different interfaces, such as CLI, PR Comments, or by automatically triggering them when a new PR is opened.)
[//]: # ()
[//]: # (- See the [Tools Guide]&#40;https://qodo-merge-docs.qodo.ai/tools/&#41; for a detailed description of the different tools, and the available configurations for each tool.)
## Table of Contents
- [Getting Started](#getting-started)
- [News and Updates](#news-and-updates)
- [Overview](#overview)
- [Example results](#example-results)
- [Try it now](#try-it-now)
- [Qodo Merge](https://qodo-merge-docs.qodo.ai/overview/pr_agent_pro/)
- [How it works](#how-it-works)
- [Why use PR-Agent?](#why-use-pr-agent)
- [Data privacy](#data-privacy)
- [See It in Action](#see-it-in-action)
- [Try It Now](#try-it-now)
- [Qodo Merge 💎](#qodo-merge-)
- [How It Works](#how-it-works)
- [Why Use PR-Agent?](#why-use-pr-agent)
- [Data Privacy](#data-privacy)
- [Contributing](#contributing)
- [Links](#links)
## Getting Started
### Try it Instantly
Test PR-Agent on any public GitHub repository by commenting `@CodiumAI-Agent /improve`
### GitHub Action
Add automated PR reviews to your repository with a simple workflow file using [GitHub Action setup guide](https://qodo-merge-docs.qodo.ai/installation/github/#run-as-a-github-action)
#### Other Platforms
- [GitLab webhook setup](https://qodo-merge-docs.qodo.ai/installation/gitlab/)
- [BitBucket app installation](https://qodo-merge-docs.qodo.ai/installation/bitbucket/)
- [Azure DevOps setup](https://qodo-merge-docs.qodo.ai/installation/azure/)
### CLI Usage
Run PR-Agent locally on your repository via command line: [Local CLI setup guide](https://qodo-merge-docs.qodo.ai/usage-guide/automations_and_usage/#local-repo-cli)
### Qodo Merge as post-commit in your local IDE
See [here](https://github.com/qodo-ai/agents/tree/main/agents/qodo-merge-post-commit)
### Discover Qodo Merge 💎
Zero-setup hosted solution with advanced features and priority support
- [Intro and Installation guide](https://qodo-merge-docs.qodo.ai/installation/qodo_merge/)
- [Plans & Pricing](https://www.qodo.ai/pricing/)
### Qodo Merge as a Post-commit in Your Local IDE
You can receive automatic feedback from Qodo Merge on your local IDE after each [commit](https://github.com/qodo-ai/agents/tree/main/agents/qodo-merge-post-commit)
## News and Updates
## Jul 1, 2025
You can now receive automatic feedback from Qodo Merge in your local IDE after each commit. Read more about it [here](https://github.com/qodo-ai/agents/tree/main/agents/qodo-merge-post-commit).
## Jun 21, 2025
v0.30 was [released](https://github.com/qodo-ai/pr-agent/releases)
## Jun 3, 2025
Qodo Merge now offers a simplified free tier 💎.
Organizations can use Qodo Merge at no cost, with a [monthly limit](https://qodo-merge-docs.qodo.ai/installation/qodo_merge/#cloud-users) of 75 PR reviews per organization.
## Apr 30, 2025
A new feature is now available in the `/improve` tool for Qodo Merge 💎 - Chat on code suggestions.
@ -69,106 +101,64 @@ New tool for Qodo Merge 💎 - `/scan_repo_discussions`.
Read more about it [here](https://qodo-merge-docs.qodo.ai/tools/scan_repo_discussions/).
## Apr 14, 2025
GPT-4.1 is out. And it's quite good on coding tasks...
https://openai.com/index/gpt-4-1/
<img width="512" alt="image" src="https://github.com/user-attachments/assets/a8f4c648-a058-4bdc-9825-2a4bb71a23e5" />
## March 28, 2025
A new version, v0.28, was released. See release notes [here](https://github.com/qodo-ai/pr-agent/releases/tag/v0.28).
This version includes a new tool, [Help Docs](https://qodo-merge-docs.qodo.ai/tools/help_docs/), which can answer free-text questions based on a documentation folder.
`/help_docs` is now being used to provide immediate automatic feedback to any user who [opens an issue](https://github.com/qodo-ai/pr-agent/issues/1608#issue-2897328825) on PR-Agent's open-source project
## Overview
<div style="text-align:left;">
Supported commands per platform:
| | | GitHub | GitLab | Bitbucket | Azure DevOps |
| ----- |---------------------------------------------------------------------------------------------------------|:------:|:------:|:---------:|:------------:|
| TOOLS | [Review](https://qodo-merge-docs.qodo.ai/tools/review/) | ✅ | ✅ | ✅ | ✅ |
| | [Describe](https://qodo-merge-docs.qodo.ai/tools/describe/) | ✅ | ✅ | ✅ | ✅ |
| | [Improve](https://qodo-merge-docs.qodo.ai/tools/improve/) | ✅ | ✅ | ✅ | ✅ |
| | [Ask](https://qodo-merge-docs.qodo.ai/tools/ask/) | ✅ | ✅ | ✅ | ✅ |
| | ⮑ [Ask on code lines](https://qodo-merge-docs.qodo.ai/tools/ask/#ask-lines) | ✅ | ✅ | | |
| | [Update CHANGELOG](https://qodo-merge-docs.qodo.ai/tools/update_changelog/) | ✅ | ✅ | ✅ | |
| | [Help Docs](https://qodo-merge-docs.qodo.ai/tools/help_docs/?h=auto#auto-approval) | ✅ | ✅ | ✅ | |
| | [Ticket Context](https://qodo-merge-docs.qodo.ai/core-abilities/fetching_ticket_context/) 💎 | ✅ | ✅ | | |
| | [Utilizing Best Practices](https://qodo-merge-docs.qodo.ai/tools/improve/#best-practices) 💎 | ✅ | ✅ | | |
| | [PR Chat](https://qodo-merge-docs.qodo.ai/chrome-extension/features/#pr-chat) 💎 | ✅ | | | |
| | [Suggestion Tracking](https://qodo-merge-docs.qodo.ai/tools/improve/#suggestion-tracking) 💎 | ✅ | | | |
| | [CI Feedback](https://qodo-merge-docs.qodo.ai/tools/ci_feedback/) 💎 | ✅ | | | |
| | [PR Documentation](https://qodo-merge-docs.qodo.ai/tools/documentation/) 💎 | ✅ | ✅ | | |
| | [Custom Labels](https://qodo-merge-docs.qodo.ai/tools/custom_labels/) 💎 | ✅ | ✅ | | |
| | [Analyze](https://qodo-merge-docs.qodo.ai/tools/analyze/) 💎 | ✅ | ✅ | | |
| | [Similar Code](https://qodo-merge-docs.qodo.ai/tools/similar_code/) 💎 | ✅ | | | |
| | [Custom Prompt](https://qodo-merge-docs.qodo.ai/tools/custom_prompt/) 💎 | ✅ | | | |
| | [Test](https://qodo-merge-docs.qodo.ai/tools/test/) 💎 | ✅ | | | |
| | [Implement](https://qodo-merge-docs.qodo.ai/tools/implement/) 💎 | ✅ | ✅ | ✅ | |
| | [Scan Repo Discussions](https://qodo-merge-docs.qodo.ai/tools/scan_repo_discussions/) 💎 | ✅ | | | |
| | [Auto-Approve](https://qodo-merge-docs.qodo.ai/tools/improve/?h=auto#auto-approval) 💎 | ✅ | ✅ | | |
| | | | | | |
| USAGE | [CLI](https://qodo-merge-docs.qodo.ai/usage-guide/automations_and_usage/#local-repo-cli) | ✅ | ✅ | ✅ | ✅ |
| | [App / webhook](https://qodo-merge-docs.qodo.ai/usage-guide/automations_and_usage/#github-app) | ✅ | ✅ | ✅ | ✅ |
| | [Tagging bot](https://github.com/Codium-ai/pr-agent#try-it-now) | ✅ | | | |
| | [Actions](https://qodo-merge-docs.qodo.ai/installation/github/#run-as-a-github-action) | ✅ | ✅ | ✅ | ✅ |
| | | | | | |
| CORE | [PR compression](https://qodo-merge-docs.qodo.ai/core-abilities/compression_strategy/) | ✅ | ✅ | ✅ | ✅ |
| | Adaptive and token-aware file patch fitting | ✅ | ✅ | | |
| | [Multiple models support](https://qodo-merge-docs.qodo.ai/usage-guide/changing_a_model/) | ✅ | ✅ | | |
| | [Local and global metadata](https://qodo-merge-docs.qodo.ai/core-abilities/metadata/) | ✅ | ✅ | ✅ | ✅ |
| | [Dynamic context](https://qodo-merge-docs.qodo.ai/core-abilities/dynamic_context/) | ✅ | ✅ | ✅ | ✅ |
| | [Self reflection](https://qodo-merge-docs.qodo.ai/core-abilities/self_reflection/) | ✅ | ✅ | ✅ | |
| | [Static code analysis](https://qodo-merge-docs.qodo.ai/core-abilities/static_code_analysis/) 💎 | ✅ | ✅ | | |
| | [Global and wiki configurations](https://qodo-merge-docs.qodo.ai/usage-guide/configuration_options/) 💎 | ✅ | ✅ | | |
| | [PR interactive actions](https://www.qodo.ai/images/pr_agent/pr-actions.mp4) 💎 | ✅ | | | |
| | [Impact Evaluation](https://qodo-merge-docs.qodo.ai/core-abilities/impact_evaluation/) 💎 | ✅ | ✅ | | |
| | [Code Validation 💎](https://qodo-merge-docs.qodo.ai/core-abilities/code_validation/) | ✅ | ✅ | ✅ | ✅ |
| | [Auto Best Practices 💎](https://qodo-merge-docs.qodo.ai/core-abilities/auto_best_practices/) | ✅ | | | |
| | | GitHub | GitLab | Bitbucket | Azure DevOps | Gitea |
|---------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------|:------:|:------:|:---------:|:------------:|:-----:|
| [TOOLS](https://qodo-merge-docs.qodo.ai/tools/) | [Describe](https://qodo-merge-docs.qodo.ai/tools/describe/) | ✅ | ✅ | ✅ | ✅ | ✅ |
| | [Review](https://qodo-merge-docs.qodo.ai/tools/review/) | ✅ | ✅ | ✅ | ✅ | ✅ |
| | [Improve](https://qodo-merge-docs.qodo.ai/tools/improve/) | ✅ | ✅ | ✅ | ✅ | ✅ |
| | [Ask](https://qodo-merge-docs.qodo.ai/tools/ask/) | ✅ | ✅ | ✅ | ✅ | |
| | ⮑ [Ask on code lines](https://qodo-merge-docs.qodo.ai/tools/ask/#ask-lines) | ✅ | ✅ | | | |
| | [Help Docs](https://qodo-merge-docs.qodo.ai/tools/help_docs/?h=auto#auto-approval) | ✅ | ✅ | ✅ | | |
| | [Update CHANGELOG](https://qodo-merge-docs.qodo.ai/tools/update_changelog/) | ✅ | ✅ | ✅ | ✅ | |
| | [Add Documentation](https://qodo-merge-docs.qodo.ai/tools/documentation/) 💎 | ✅ | ✅ | | | |
| | [Analyze](https://qodo-merge-docs.qodo.ai/tools/analyze/) 💎 | ✅ | ✅ | | | |
| | [Auto-Approve](https://qodo-merge-docs.qodo.ai/tools/improve/?h=auto#auto-approval) 💎 | ✅ | | | | |
| | [CI Feedback](https://qodo-merge-docs.qodo.ai/tools/ci_feedback/) 💎 | ✅ | | | | |
| | [Custom Prompt](https://qodo-merge-docs.qodo.ai/tools/custom_prompt/) 💎 | ✅ | ✅ | ✅ | | |
| | [Generate Custom Labels](https://qodo-merge-docs.qodo.ai/tools/custom_labels/) 💎 | ✅ | ✅ | | | |
| | [Generate Tests](https://qodo-merge-docs.qodo.ai/tools/test/) 💎 | ✅ | ✅ | | | |
| | [Implement](https://qodo-merge-docs.qodo.ai/tools/implement/) 💎 | ✅ | ✅ | | | |
| | [Scan Repo Discussions](https://qodo-merge-docs.qodo.ai/tools/scan_repo_discussions/) 💎 | ✅ | | | | |
| | [Similar Code](https://qodo-merge-docs.qodo.ai/tools/similar_code/) 💎 | ✅ | | | | |
| | [Ticket Context](https://qodo-merge-docs.qodo.ai/core-abilities/fetching_ticket_context/) 💎 | ✅ | ✅ | | | |
| | [Utilizing Best Practices](https://qodo-merge-docs.qodo.ai/tools/improve/#best-practices) 💎 | ✅ | ✅ | ✅ | | |
| | [PR Chat](https://qodo-merge-docs.qodo.ai/chrome-extension/features/#pr-chat) 💎 | ✅ | | | | |
| | [Suggestion Tracking](https://qodo-merge-docs.qodo.ai/tools/improve/#suggestion-tracking) 💎 | ✅ | ✅ | | | |
| | | | | | | |
| [USAGE](https://qodo-merge-docs.qodo.ai/usage-guide/) | [CLI](https://qodo-merge-docs.qodo.ai/usage-guide/automations_and_usage/#local-repo-cli) | ✅ | ✅ | ✅ | ✅ | ✅ |
| | [App / webhook](https://qodo-merge-docs.qodo.ai/usage-guide/automations_and_usage/#github-app) | ✅ | ✅ | ✅ | ✅ | ✅ |
| | [Tagging bot](https://github.com/Codium-ai/pr-agent#try-it-now) | ✅ | | | | |
| | [Actions](https://qodo-merge-docs.qodo.ai/installation/github/#run-as-a-github-action) | ✅ | ✅ | ✅ | ✅ | |
| | | | | | | |
| [CORE](https://qodo-merge-docs.qodo.ai/core-abilities/) | [Adaptive and token-aware file patch fitting](https://qodo-merge-docs.qodo.ai/core-abilities/compression_strategy/) | ✅ | ✅ | ✅ | ✅ | |
| | [Auto Best Practices 💎](https://qodo-merge-docs.qodo.ai/core-abilities/auto_best_practices/) | ✅ | | | | |
| | [Chat on code suggestions](https://qodo-merge-docs.qodo.ai/core-abilities/chat_on_code_suggestions/) | ✅ | ✅ | | | |
| | [Code Validation 💎](https://qodo-merge-docs.qodo.ai/core-abilities/code_validation/) | ✅ | ✅ | ✅ | ✅ | |
| | [Dynamic context](https://qodo-merge-docs.qodo.ai/core-abilities/dynamic_context/) | ✅ | ✅ | ✅ | ✅ | |
| | [Fetching ticket context](https://qodo-merge-docs.qodo.ai/core-abilities/fetching_ticket_context/) | ✅ | ✅ | ✅ | | |
| | [Global and wiki configurations](https://qodo-merge-docs.qodo.ai/usage-guide/configuration_options/) 💎 | ✅ | ✅ | | | |
| | [Impact Evaluation](https://qodo-merge-docs.qodo.ai/core-abilities/impact_evaluation/) 💎 | ✅ | ✅ | | | |
| | [Incremental Update](https://qodo-merge-docs.qodo.ai/core-abilities/incremental_update/) | ✅ | | | | |
| | [Interactivity](https://qodo-merge-docs.qodo.ai/core-abilities/interactivity/) | ✅ | ✅ | | | |
| | [Local and global metadata](https://qodo-merge-docs.qodo.ai/core-abilities/metadata/) | ✅ | ✅ | ✅ | ✅ | |
| | [Multiple models support](https://qodo-merge-docs.qodo.ai/usage-guide/changing_a_model/) | ✅ | | | ✅ | |
| | [PR compression](https://qodo-merge-docs.qodo.ai/core-abilities/compression_strategy/) | ✅ | ✅ | ✅ | ✅ | |
| | [PR interactive actions](https://www.qodo.ai/images/pr_agent/pr-actions.mp4) 💎 | ✅ | ✅ | | | |
| | [RAG context enrichment](https://qodo-merge-docs.qodo.ai/core-abilities/rag_context_enrichment/) | ✅ | | ✅ | | |
| | [Self reflection](https://qodo-merge-docs.qodo.ai/core-abilities/self_reflection/) | ✅ | ✅ | ✅ | ✅ | |
| | [Static code analysis](https://qodo-merge-docs.qodo.ai/core-abilities/static_code_analysis/) 💎 | ✅ | ✅ | | | |
- 💎 means this feature is available only in [Qodo Merge](https://www.qodo.ai/pricing/)
[//]: # (- Support for additional git providers is described in [here]&#40;./docs/Full_environments.md&#41;)
___
**Auto Description ([`/describe`](https://qodo-merge-docs.qodo.ai/tools/describe/))**: Automatically generating PR description - title, type, summary, code walkthrough and labels.
\
**Auto Review ([`/review`](https://qodo-merge-docs.qodo.ai/tools/review/))**: Adjustable feedback about the PR, possible issues, security concerns, review effort and more.
\
**Code Suggestions ([`/improve`](https://qodo-merge-docs.qodo.ai/tools/improve/))**: Code suggestions for improving the PR.
\
**Question Answering ([`/ask ...`](https://qodo-merge-docs.qodo.ai/tools/ask/))**: Answering free-text questions about the PR.
\
**Update Changelog ([`/update_changelog`](https://qodo-merge-docs.qodo.ai/tools/update_changelog/))**: Automatically updating the CHANGELOG.md file with the PR changes.
\
**Help Docs ([`/help_docs`](https://qodo-merge-docs.qodo.ai/tools/help_docs/))**: Answers a question on any repository by utilizing given documentation.
\
**Add Documentation 💎 ([`/add_docs`](https://qodo-merge-docs.qodo.ai/tools/documentation/))**: Generates documentation to methods/functions/classes that changed in the PR.
\
**Generate Custom Labels 💎 ([`/generate_labels`](https://qodo-merge-docs.qodo.ai/tools/custom_labels/))**: Generates custom labels for the PR, based on specific guidelines defined by the user.
\
**Analyze 💎 ([`/analyze`](https://qodo-merge-docs.qodo.ai/tools/analyze/))**: Identify code components that changed in the PR, and enables to interactively generate tests, docs, and code suggestions for each component.
\
**Test 💎 ([`/test`](https://qodo-merge-docs.qodo.ai/tools/test/))**: Generate tests for a selected component, based on the PR code changes.
\
**Custom Prompt 💎 ([`/custom_prompt`](https://qodo-merge-docs.qodo.ai/tools/custom_prompt/))**: Automatically generates custom suggestions for improving the PR code, based on specific guidelines defined by the user.
\
**Generate Tests 💎 ([`/test component_name`](https://qodo-merge-docs.qodo.ai/tools/test/))**: Generates unit tests for a selected component, based on the PR code changes.
\
**CI Feedback 💎 ([`/checks ci_job`](https://qodo-merge-docs.qodo.ai/tools/ci_feedback/))**: Automatically generates feedback and analysis for a failed CI job.
\
**Similar Code 💎 ([`/find_similar_component`](https://qodo-merge-docs.qodo.ai/tools/similar_code/))**: Retrieves the most similar code components from inside the organization's codebase, or from open-source code.
\
**Implement 💎 ([`/implement`](https://qodo-merge-docs.qodo.ai/tools/implement/))**: Generates implementation code from review suggestions.
___
## Example results
## See It in Action
</div>
<h4><a href="https://github.com/Codium-ai/pr-agent/pull/530">/describe</a></h4>
@ -203,7 +193,7 @@ ___
</div>
<hr>
## Try it now
## Try It Now
Try the Claude Sonnet 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:
@ -229,7 +219,7 @@ It does not have 'edit' access to your repo, for example, so it cannot update th
4. **Extra features** - In addition to the benefits listed above, Qodo Merge 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 Qodo Merge.
## How it works
## How It Works
The following diagram illustrates PR-Agent tools and their flow:
@ -237,7 +227,7 @@ The following diagram illustrates PR-Agent tools and their flow:
Check out the [PR Compression strategy](https://qodo-merge-docs.qodo.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?
## Why Use PR-Agent?
A reasonable question that can be asked is: `"Why use PR-Agent? What makes it stand out from existing tools?"`
@ -245,10 +235,10 @@ Here are some advantages of PR-Agent:
- We emphasize **real-life practical usage**. Each tool (review, improve, ask, ...) has a single LLM 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](https://qodo-merge-docs.qodo.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.
- Our JSON prompting strategy enables us 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), **multiple ways** to use the tool (CLI, GitHub Action, GitHub App, Docker, ...), and **multiple models** (GPT, Claude, Deepseek, ...)
## Data privacy
## Data Privacy
### Self-hosted PR-Agent
@ -273,7 +263,7 @@ To contribute to the project, get started by reading our [Contributing Guide](ht
## Links
- Discord community: https://discord.gg/kG35uSHDBc
- Discord community: https://discord.com/invite/SgSxuQ65GF
- Qodo site: https://www.qodo.ai/
- Blog: https://www.qodo.ai/blog/
- Troubleshooting: https://www.qodo.ai/blog/technical-faq-and-troubleshooting/

View File

@ -33,6 +33,11 @@ FROM base AS azure_devops_webhook
ADD pr_agent pr_agent
CMD ["python", "pr_agent/servers/azuredevops_server_webhook.py"]
FROM base AS gitea_app
ADD pr_agent pr_agent
CMD ["python", "-m", "gunicorn", "-k", "uvicorn.workers.UvicornWorker", "-c", "pr_agent/servers/gunicorn_config.py","pr_agent.servers.gitea_app:app"]
FROM base AS test
ADD requirements-dev.txt .
RUN pip install --no-cache-dir -r requirements-dev.txt && rm requirements-dev.txt

View File

@ -1,4 +1,4 @@
FROM public.ecr.aws/lambda/python:3.12
FROM public.ecr.aws/lambda/python:3.12 AS base
RUN dnf update -y && \
dnf install -y gcc python3-devel git && \
@ -9,4 +9,10 @@ RUN pip install --no-cache-dir . && rm pyproject.toml
RUN pip install --no-cache-dir mangum==0.17.0
COPY pr_agent/ ${LAMBDA_TASK_ROOT}/pr_agent/
CMD ["pr_agent.servers.serverless.serverless"]
FROM base AS github_lambda
CMD ["pr_agent.servers.github_lambda_webhook.lambda_handler"]
FROM base AS gitlab_lambda
CMD ["pr_agent.servers.gitlab_lambda_webhook.lambda_handler"]
FROM github_lambda

View File

@ -202,7 +202,23 @@ h1 {
<script>
window.addEventListener('load', function() {
function displayResults(responseText) {
function extractText(responseText) {
try {
console.log('responseText: ', responseText);
const results = JSON.parse(responseText);
const msg = results.message;
if (!msg || msg.trim() === '') {
return "No results found";
}
return msg;
} catch (error) {
console.error('Error parsing results:', error);
throw new Error("Failed parsing response message");
}
}
function displayResults(msg) {
const resultsContainer = document.getElementById('results');
const spinner = document.getElementById('spinner');
const searchContainer = document.querySelector('.search-container');
@ -214,8 +230,6 @@ window.addEventListener('load', function() {
searchContainer.scrollIntoView({ behavior: 'smooth', block: 'start' });
try {
const results = JSON.parse(responseText);
marked.setOptions({
breaks: true,
gfm: true,
@ -223,7 +237,7 @@ window.addEventListener('load', function() {
sanitize: false
});
const htmlContent = marked.parse(results.message);
const htmlContent = marked.parse(msg);
resultsContainer.className = 'markdown-content';
resultsContainer.innerHTML = htmlContent;
@ -242,7 +256,7 @@ window.addEventListener('load', function() {
}, 100);
} catch (error) {
console.error('Error parsing results:', error);
resultsContainer.innerHTML = '<div class="error-message">Error processing results</div>';
resultsContainer.innerHTML = '<div class="error-message">Cannot process results</div>';
}
}
@ -275,24 +289,25 @@ window.addEventListener('load', function() {
body: JSON.stringify(data)
};
// const API_ENDPOINT = 'http://0.0.0.0:3000/api/v1/docs_help';
//const API_ENDPOINT = 'http://0.0.0.0:3000/api/v1/docs_help';
const API_ENDPOINT = 'https://help.merge.qodo.ai/api/v1/docs_help';
const response = await fetch(API_ENDPOINT, options);
const responseText = await response.text();
const msg = extractText(responseText);
if (!response.ok) {
throw new Error(`HTTP error! status: ${response.status}`);
throw new Error(`An error (${response.status}) occurred during search: "${msg}"`);
}
const responseText = await response.text();
displayResults(responseText);
displayResults(msg);
} catch (error) {
spinner.style.display = 'none';
resultsContainer.innerHTML = `
<div class="error-message">
An error occurred while searching. Please try again later.
</div>
`;
const errorDiv = document.createElement('div');
errorDiv.className = 'error-message';
errorDiv.textContent = `${error}`;
resultsContainer.value = "";
resultsContainer.appendChild(errorDiv);
}
}

View File

@ -4,7 +4,7 @@ With a single-click installation you will gain access to a context-aware chat on
The extension is powered by top code models like Claude 3.7 Sonnet and o4-mini. All the extension's features are free to use on public repositories.
For private repositories, you will need to install [Qodo Merge](https://github.com/apps/qodo-merge-pro){:target="_blank"} in addition to the extension (Quick GitHub app setup with a 14-day free trial. No credit card needed).
For private repositories, you will need to install [Qodo Merge](https://github.com/apps/qodo-merge-pro){:target="_blank"} in addition to the extension.
For a demonstration of how to install Qodo Merge 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){:target="_blank"}.
<img src="https://codium.ai/images/pr_agent/PR-AgentChat.gif" width="768">

View File

@ -0,0 +1,83 @@
# Auto-approval 💎
`Supported Git Platforms: GitHub, GitLab, Bitbucket`
Under specific conditions, Qodo Merge can auto-approve a PR when a manual comment is invoked, or when the PR meets certain criteria.
**To ensure safety, the auto-approval feature is disabled by default.**
To enable auto-approval features, you need to actively set one or both of the following options in a pre-defined _configuration file_:
```toml
[config]
enable_comment_approval = true # For approval via comments
enable_auto_approval = true # For criteria-based auto-approval
```
!!! note "Notes"
- These flags above cannot be set with a command line argument, only in the configuration file, committed to the repository.
- Enabling auto-approval must be a deliberate decision by the repository owner.
## **Approval by commenting**
To enable approval by commenting, set in the configuration file:
```toml
[config]
enable_comment_approval = true
```
After enabling, by commenting on a PR:
```
/review auto_approve
```
Qodo Merge will approve the PR and add a comment with the reason for the approval.
## **Auto-approval when the PR meets certain criteria**
To enable auto-approval based on specific criteria, first, you need to enable the top-level flag:
```toml
[config]
enable_auto_approval = true
```
There are two possible paths leading to this auto-approval - one via the `review` tool, and one via the `improve` tool. Each tool can independently trigger auto-approval.
### Auto-approval via the `review` tool
- **Review effort score criteria**
```toml
[config]
enable_auto_approval = true
auto_approve_for_low_review_effort = X # X is a number between 1 and 5
```
When the [review effort score](https://www.qodo.ai/images/pr_agent/review3.png) is lower than or equal to X, the PR will be auto-approved (unless ticket compliance is enabled and fails, see below).
- **Ticket compliance criteria**
```toml
[config]
enable_auto_approval = true
ensure_ticket_compliance = true # Default is false
```
If `ensure_ticket_compliance` is set to `true`, auto-approval for the `review` toll path will be disabled if no ticket is linked to the PR, or if the PR is not fully compliant with a linked ticket. This ensures that PRs are only auto-approved if their associated tickets are properly resolved.
You can also prevent auto-approval if the PR exceeds the ticket's scope (see [here](https://qodo-merge-docs.qodo.ai/core-abilities/fetching_ticket_context/#configuration-options)).
### Auto-approval via the `improve` tool
PRs can be auto-approved when the `improve` tool doesn't find code suggestions.
To enable this feature, set the following in the configuration file:
```toml
[config]
enable_auto_approval = true
auto_approve_for_no_suggestions = true
```

View File

@ -0,0 +1,55 @@
# Chat on code suggestions 💎
`Supported Git Platforms: GitHub, GitLab`
## Overview
Qodo Merge implements an orchestrator agent that enables interactive code discussions, listening and responding to comments without requiring explicit tool calls.
The orchestrator intelligently analyzes your responses to determine if you want to implement a suggestion, ask a question, or request help, then delegates to the appropriate specialized tool.
To minimize unnecessary notifications and maintain focused discussions, the orchestrator agent will only respond to comments made directly within the inline code suggestion discussions it has created (`/improve`) or within discussions initiated by the `/implement` command.
## Getting Started
### Setup
Enable interactive code discussions by adding the following to your configuration file (default is `True`):
```toml
[pr_code_suggestions]
enable_chat_in_code_suggestions = true
```
### Activation
#### `/improve`
To obtain dynamic responses, the following steps are required:
1. Run the `/improve` command (mostly automatic)
2. Check the `/improve` recommendation checkboxes (_Apply this suggestion_) to have Qodo Merge generate a new inline code suggestion discussion
3. The orchestrator agent will then automatically listen to and reply to comments within the discussion without requiring additional commands
#### `/implement`
To obtain dynamic responses, the following steps are required:
1. Select code lines in the PR diff and run the `/implement` command
2. Wait for Qodo Merge to generate a new inline code suggestion
3. The orchestrator agent will then automatically listen to and reply to comments within the discussion without requiring additional commands
## Explore the available interaction patterns
!!! tip "Tip: Direct the agent with keywords"
Use "implement" or "apply" for code generation. Use "explain", "why", or "how" for information and help.
=== "Asking for Details"
![Chat on code suggestions ask](https://codium.ai/images/pr_agent/improve_chat_on_code_suggestions_ask.png){width=512}
=== "Implementing Suggestions"
![Chat on code suggestions implement](https://codium.ai/images/pr_agent/improve_chat_on_code_suggestions_implement.png){width=512}
=== "Providing Additional Help"
![Chat on code suggestions help](https://codium.ai/images/pr_agent/improve_chat_on_code_suggestions_help.png){width=512}

View File

@ -1,3 +1,8 @@
# Code Validation 💎
`Supported Git Platforms: GitHub, GitLab, Bitbucket`
## Introduction
The Git environment usually represents the final stage before code enters production. Hence, Detecting bugs and issues during the review process is critical.

View File

@ -1,5 +1,8 @@
## Overview - PR Compression Strategy
`Supported Git Platforms: GitHub, GitLab, Bitbucket`
## Overview
There are two scenarios:

View File

@ -1,4 +1,5 @@
## TL;DR
`Supported Git Platforms: GitHub, GitLab, Bitbucket`
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).

View File

@ -9,8 +9,9 @@ This integration enriches the review process by automatically surfacing relevant
**Ticket systems supported**:
- GitHub
- Jira (💎)
- [GitHub](https://qodo-merge-docs.qodo.ai/core-abilities/fetching_ticket_context/#github-issues-integration)
- [Jira (💎)](https://qodo-merge-docs.qodo.ai/core-abilities/fetching_ticket_context/#jira-integration)
- [Linear (💎)](https://qodo-merge-docs.qodo.ai/core-abilities/fetching_ticket_context/#linear-integration)
**Ticket data fetched:**
@ -38,17 +39,40 @@ By understanding the reasoning and intent behind modifications, the LLM can offe
Similarly to the `describe` tool, the `review` tool will use the ticket content to provide additional context for the code changes.
In addition, this feature will evaluate how well a Pull Request (PR) adheres to its original purpose/intent as defined by the associated ticket or issue mentioned in the PR description.
Each ticket will be assigned a label (Compliance/Alignment level), Indicates the degree to which the PR fulfills its original purpose, Options: Fully compliant, Partially compliant or Not compliant.
Each ticket will be assigned a label (Compliance/Alignment level), Indicates the degree to which the PR fulfills its original purpose:
- Fully Compliant
- Partially Compliant
- Not Compliant
- PR Code Verified
![Ticket Compliance](https://www.qodo.ai/images/pr_agent/ticket_compliance_review.png){width=768}
By default, the tool will automatically validate if the PR complies with the referenced ticket.
If you want to disable this feedback, add the following line to your configuration file:
A `PR Code Verified` label indicates the PR code meets ticket requirements, but requires additional manual testing beyond the code scope. For example - validating UI display across different environments (Mac, Windows, mobile, etc.).
```toml
[pr_reviewer]
require_ticket_analysis_review=false
```
#### Configuration options
-
By default, the tool will automatically validate if the PR complies with the referenced ticket.
If you want to disable this feedback, add the following line to your configuration file:
```toml
[pr_reviewer]
require_ticket_analysis_review=false
```
-
If you set:
```toml
[pr_reviewer]
check_pr_additional_content=true
```
(default: `false`)
the `review` tool will also validate that the PR code doesn't contain any additional content that is not related to the ticket. If it does, the PR will be labeled at best as `PR Code Verified`, and the `review` tool will provide a comment with the additional unrelated content found in the PR code.
## GitHub Issues Integration
@ -75,13 +99,17 @@ The recommended way to authenticate with Jira Cloud is to install the Qodo Merge
Installation steps:
1. Click [here](https://auth.atlassian.com/authorize?audience=api.atlassian.com&client_id=8krKmA4gMD8mM8z24aRCgPCSepZNP1xf&scope=read%3Ajira-work%20offline_access&redirect_uri=https%3A%2F%2Fregister.jira.pr-agent.codium.ai&state=qodomerge&response_type=code&prompt=consent) to install the Qodo Merge app in your Jira Cloud instance, click the `accept` button.<br>
1. Go to the [Qodo Merge integrations page](https://app.qodo.ai/qodo-merge/integrations)
2. Click on the Connect **Jira Cloud** button to connect the Jira Cloud app
3. Click the `accept` button.<br>
![Jira Cloud App Installation](https://www.qodo.ai/images/pr_agent/jira_app_installation1.png){width=384}
2. After installing the app, you will be redirected to the Qodo Merge registration page. and you will see a success message.<br>
4. After installing the app, you will be redirected to the Qodo Merge registration page. and you will see a success message.<br>
![Jira Cloud App success message](https://www.qodo.ai/images/pr_agent/jira_app_success.png){width=384}
3. Now Qodo Merge will be able to fetch Jira ticket context for your PRs.
5. Now Qodo Merge will be able to fetch Jira ticket context for your PRs.
**2) Email/Token Authentication**
@ -190,7 +218,7 @@ This following steps will help you check if the basic auth is working correctly,
2. run the following Python script (after replacing the placeholders with your actual values):
??? example "Script to validate basic auth"
???- example "Script to validate basic auth"
```python
from jira import JIRA
@ -246,7 +274,7 @@ This following steps will help you check if the token is working correctly, and
2. run the following Python script (after replacing the placeholders with your actual values):
??? example "Script to validate PAT token"
??? example- "Script to validate PAT token"
```python
from jira import JIRA
@ -281,13 +309,90 @@ This following steps will help you check if the token is working correctly, and
print(f"Error fetching JIRA ticket details: {e}")
```
### Multi-JIRA Server Configuration 💎
Qodo Merge supports connecting to multiple JIRA servers using different authentication methods.
=== "Email/Token (Basic Auth)"
Configure multiple servers using Email/Token authentication:
- `jira_servers`: List of JIRA server URLs
- `jira_api_token`: List of API tokens (for Cloud) or passwords (for Data Center)
- `jira_api_email`: List of emails (for Cloud) or usernames (for Data Center)
- `jira_base_url`: Default server for ticket IDs like `PROJ-123`, Each repository can configure (local config file) its own `jira_base_url` to choose which server to use by default.
**Example Configuration:**
```toml
[jira]
# Server URLs
jira_servers = ["https://company.atlassian.net", "https://datacenter.jira.com"]
# API tokens/passwords
jira_api_token = ["cloud_api_token_here", "datacenter_password"]
# Emails/usernames (both required)
jira_api_email = ["user@company.com", "datacenter_username"]
# Default server for ticket IDs
jira_base_url = "https://company.atlassian.net"
```
=== "PAT Auth"
Configure multiple servers using Personal Access Token authentication:
- `jira_servers`: List of JIRA server URLs
- `jira_api_token`: List of PAT tokens
- `jira_api_email`: Not needed (can be omitted or left empty)
- `jira_base_url`: Default server for ticket IDs like `PROJ-123`, Each repository can configure (local config file) its own `jira_base_url` to choose which server to use by default.
**Example Configuration:**
```toml
[jira]
# Server URLs
jira_servers = ["https://server1.jira.com", "https://server2.jira.com"]
# PAT tokens only
jira_api_token = ["pat_token_1", "pat_token_2"]
# Default server for ticket IDs
jira_base_url = "https://server1.jira.com"
```
**Mixed Authentication (Email/Token + PAT):**
```toml
[jira]
jira_servers = ["https://company.atlassian.net", "https://server.jira.com"]
jira_api_token = ["cloud_api_token", "server_pat_token"]
jira_api_email = ["user@company.com", ""] # Empty for PAT
```
=== "Jira Cloud App"
For Jira Cloud instances using App Authentication:
1. Install the Qodo Merge app on each JIRA Cloud instance you want to connect to
2. Set the default server for ticket ID resolution:
```toml
[jira]
jira_base_url = "https://primary-team.atlassian.net"
```
Full URLs (e.g., `https://other-team.atlassian.net/browse/TASK-456`) will automatically use the correct connected instance.
### How to link a PR to a Jira ticket
To integrate with Jira, you can link your PR to a ticket using either of these methods:
**Method 1: Description Reference:**
Include a ticket reference in your PR description using either the complete URL format https://<JIRA_ORG>.atlassian.net/browse/ISSUE-123 or the shortened ticket ID ISSUE-123.
Include a ticket reference in your PR description, using either the complete URL format `https://<JIRA_ORG>.atlassian.net/browse/ISSUE-123` or the shortened ticket ID `ISSUE-123` (without prefix or suffix for the shortened ID).
**Method 2: Branch Name Detection:**
@ -300,3 +405,46 @@ Name your branch with the ticket ID as a prefix (e.g., `ISSUE-123-feature-descri
[jira]
jira_base_url = "https://<JIRA_ORG>.atlassian.net"
```
Where `<JIRA_ORG>` is your Jira organization identifier (e.g., `mycompany` for `https://mycompany.atlassian.net`).
## Linear Integration 💎
### Linear App Authentication
The recommended way to authenticate with Linear is to connect the Linear app through the Qodo Merge portal.
Installation steps:
1. Go to the [Qodo Merge integrations page](https://app.qodo.ai/qodo-merge/integrations)
2. Navigate to the **Integrations** tab
3. Click on the **Linear** button to connect the Linear app
4. Follow the authentication flow to authorize Qodo Merge to access your Linear workspace
5. Once connected, Qodo Merge will be able to fetch Linear ticket context for your PRs
### How to link a PR to a Linear ticket
Qodo Merge will automatically detect Linear tickets using either of these methods:
**Method 1: Description Reference:**
Include a ticket reference in your PR description using either:
- The complete Linear ticket URL: `https://linear.app/[ORG_ID]/issue/[TICKET_ID]`
- The shortened ticket ID: `[TICKET_ID]` (e.g., `ABC-123`) - requires linear_base_url configuration (see below).
**Method 2: Branch Name Detection:**
Name your branch with the ticket ID as a prefix (e.g., `ABC-123-feature-description` or `feature/ABC-123/feature-description`).
!!! note "Linear Base URL"
For shortened ticket IDs or branch detection (method 2), you must configure the Linear base URL in your configuration file under the [linear] section:
```toml
[linear]
linear_base_url = "https://linear.app/[ORG_ID]"
```
Replace `[ORG_ID]` with your Linear organization identifier.

View File

@ -1,4 +1,6 @@
# Overview - Impact Evaluation 💎
# Impact Evaluation 💎
`Supported Git Platforms: GitHub, GitLab, Bitbucket`
Demonstrating the return on investment (ROI) of AI-powered initiatives is crucial for modern organizations.
To address this need, Qodo Merge has developed an AI impact measurement tools and metrics, providing advanced analytics to help businesses quantify the tangible benefits of AI adoption in their PR review process.

View File

@ -0,0 +1,33 @@
# Incremental Update 💎
`Supported Git Platforms: GitHub, GitLab (Both cloud & server. For server: Version 17 and above)`
## Overview
The Incremental Update feature helps users focus on feedback for their newest changes, making large PRs more manageable.
### How it works
=== "Update Option on Subsequent Commits"
![code_suggestions_update](https://www.qodo.ai/images/pr_agent/inc_update_before.png){width=512}
=== "Generation of Incremental Update"
![code_suggestions_inc_update_result](https://www.qodo.ai/images/pr_agent/inc_update_shown.png){width=512}
___
Whenever new commits are pushed following a recent code suggestions report for this PR, an Update button appears (as seen above).
Once the user clicks on the button:
- The `improve` tool identifies the new changes (the "delta")
- Provides suggestions on these recent changes
- Combines these suggestions with the overall PR feedback, prioritizing delta-related comments
- Marks delta-related comments with a textual indication followed by an asterisk (*) with a link to this page, so they can easily be identified
### Benefits for Developers
- Focus on what matters: See feedback on newest code first
- Clearer organization: Comments on recent changes are clearly marked
- Better workflow: Address feedback more systematically, starting with recent changes

View File

@ -2,12 +2,15 @@
Qodo Merge utilizes a variety of core abilities to provide a comprehensive and efficient code review experience. These abilities include:
- [Auto approval](https://qodo-merge-docs.qodo.ai/core-abilities/auto_approval/)
- [Auto best practices](https://qodo-merge-docs.qodo.ai/core-abilities/auto_best_practices/)
- [Chat on code suggestions](https://qodo-merge-docs.qodo.ai/core-abilities/chat_on_code_suggestions/)
- [Code validation](https://qodo-merge-docs.qodo.ai/core-abilities/code_validation/)
- [Compression strategy](https://qodo-merge-docs.qodo.ai/core-abilities/compression_strategy/)
- [Dynamic context](https://qodo-merge-docs.qodo.ai/core-abilities/dynamic_context/)
- [Fetching ticket context](https://qodo-merge-docs.qodo.ai/core-abilities/fetching_ticket_context/)
- [Impact evaluation](https://qodo-merge-docs.qodo.ai/core-abilities/impact_evaluation/)
- [Incremental Update](https://qodo-merge-docs.qodo.ai/core-abilities/incremental_update/)
- [Interactivity](https://qodo-merge-docs.qodo.ai/core-abilities/interactivity/)
- [Local and global metadata](https://qodo-merge-docs.qodo.ai/core-abilities/metadata/)
- [RAG context enrichment](https://qodo-merge-docs.qodo.ai/core-abilities/rag_context_enrichment/)

View File

@ -1,4 +1,4 @@
# Interactivity
# Interactivity 💎
`Supported Git Platforms: GitHub, GitLab`

View File

@ -1,4 +1,6 @@
## Local and global metadata injection with multi-stage analysis
# Local and global metadata injection with multi-stage analysis
`Supported Git Platforms: GitHub, GitLab, Bitbucket`
1\.
Qodo Merge initially retrieves for each PR the following data:

View File

@ -27,7 +27,7 @@ In order to enable the RAG feature, add the following lines to your configuratio
enable_rag=true
```
!!! example "RAG Arguments Options"
???+ example "RAG Arguments Options"
<table>
<tr>

View File

@ -1,4 +1,4 @@
## TL;DR
`Supported Git Platforms: GitHub, GitLab, Bitbucket`
Qodo Merge implements a **self-reflection** process where the AI model reflects, scores, and re-ranks its own suggestions, eliminating irrelevant or incorrect ones.
This approach improves the quality and relevance of suggestions, saving users time and enhancing their experience.

View File

@ -1,11 +1,14 @@
## Overview - Static Code Analysis 💎
# Static Code Analysis 💎
` Supported Git Platforms: GitHub, GitLab, Bitbucket`
By combining static code analysis with LLM capabilities, Qodo Merge can provide a comprehensive analysis of the PR code changes on a component level.
It scans the PR code changes, finds all the code components (methods, functions, classes) that changed, and enables to interactively generate tests, docs, code suggestions and similar code search for each component.
!!! note "Language that are currently supported:"
Python, Java, C++, JavaScript, TypeScript, C#.
Python, Java, C++, JavaScript, TypeScript, C#, Go.
## Capabilities

View File

@ -26,47 +26,52 @@ To search the documentation site using natural language:
PR-Agent and Qodo Merge offers extensive pull request functionalities across various git providers:
| | | GitHub | GitLab | Bitbucket | Azure DevOps |
| ----- | ------------------------------------------------------------------------------------------------------- |:------:|:------:|:---------:|:------------:|
| TOOLS | [Review](https://qodo-merge-docs.qodo.ai/tools/review/) | ✅ | ✅ | ✅ | ✅ |
| | [Describe](https://qodo-merge-docs.qodo.ai/tools/describe/) | ✅ | ✅ | ✅ | ✅ |
| | [Improve](https://qodo-merge-docs.qodo.ai/tools/improve/) | ✅ | ✅ | ✅ | ✅ |
| | [Ask](https://qodo-merge-docs.qodo.ai/tools/ask/) | ✅ | ✅ | ✅ | ✅ |
| | ⮑ [Ask on code lines](https://qodo-merge-docs.qodo.ai/tools/ask/#ask-lines) | ✅ | ✅ | | |
| | [Update CHANGELOG](https://qodo-merge-docs.qodo.ai/tools/update_changelog/) | ✅ | ✅ | ✅ | |
| | [Help Docs](https://qodo-merge-docs.qodo.ai/tools/help_docs/?h=auto#auto-approval) | ✅ | ✅ | ✅ | |
| | [Ticket Context](https://qodo-merge-docs.qodo.ai/core-abilities/fetching_ticket_context/) 💎 | ✅ | ✅ | | |
| | [Utilizing Best Practices](https://qodo-merge-docs.qodo.ai/tools/improve/#best-practices) 💎 | ✅ | ✅ | | |
| | [PR Chat](https://qodo-merge-docs.qodo.ai/chrome-extension/features/#pr-chat) 💎 | ✅ | | | |
| | [Suggestion Tracking](https://qodo-merge-docs.qodo.ai/tools/improve/#suggestion-tracking) 💎 | ✅ | | | |
| | [CI Feedback](https://qodo-merge-docs.qodo.ai/tools/ci_feedback/) 💎 | ✅ | | | |
| | [PR Documentation](https://qodo-merge-docs.qodo.ai/tools/documentation/) 💎 | ✅ | ✅ | | |
| | [Custom Labels](https://qodo-merge-docs.qodo.ai/tools/custom_labels/) 💎 | ✅ | ✅ | | |
| | [Analyze](https://qodo-merge-docs.qodo.ai/tools/analyze/) 💎 | ✅ | ✅ | | |
| | [Similar Code](https://qodo-merge-docs.qodo.ai/tools/similar_code/) 💎 | ✅ | | | |
| | [Custom Prompt](https://qodo-merge-docs.qodo.ai/tools/custom_prompt/) 💎 | ✅ | ✅ | | |
| | [Test](https://qodo-merge-docs.qodo.ai/tools/test/) 💎 | ✅ | | | |
| | [Implement](https://qodo-merge-docs.qodo.ai/tools/implement/) 💎 | ✅ | ✅ | ✅ | |
| | [Scan Repo Discussions](https://qodo-merge-docs.qodo.ai/tools/scan_repo_discussions/) 💎 | ✅ | | | |
| | [Auto-Approve](https://qodo-merge-docs.qodo.ai/tools/improve/?h=auto#auto-approval) 💎 | ✅ | ✅ | | |
| | | | | | |
| USAGE | [CLI](https://qodo-merge-docs.qodo.ai/usage-guide/automations_and_usage/#local-repo-cli) | ✅ | ✅ | ✅ | ✅ |
| | [App / webhook](https://qodo-merge-docs.qodo.ai/usage-guide/automations_and_usage/#github-app) | ✅ | ✅ | ✅ | ✅ |
| | [Tagging bot](https://github.com/Codium-ai/pr-agent#try-it-now) | ✅ | | | |
| | [Actions](https://qodo-merge-docs.qodo.ai/installation/github/#run-as-a-github-action) | ✅ | ✅ | ✅ | ✅ |
| | | | | | |
| CORE | [PR compression](https://qodo-merge-docs.qodo.ai/core-abilities/compression_strategy/) | ✅ | ✅ | ✅ | ✅ |
| | Adaptive and token-aware file patch fitting | | ✅ | ✅ | |
| | [Multiple models support](https://qodo-merge-docs.qodo.ai/usage-guide/changing_a_model/) | ✅ | ✅ | | |
| | [Local and global metadata](https://qodo-merge-docs.qodo.ai/core-abilities/metadata/) | ✅ | ✅ | ✅ | ✅ |
| | [Dynamic context](https://qodo-merge-docs.qodo.ai/core-abilities/dynamic_context/) | ✅ | ✅ | ✅ | ✅ |
| | [Self reflection](https://qodo-merge-docs.qodo.ai/core-abilities/self_reflection/) | ✅ | ✅ | ✅ | |
| | [Static code analysis](https://qodo-merge-docs.qodo.ai/core-abilities/static_code_analysis/) 💎 | ✅ | ✅ | | |
| | [Global and wiki configurations](https://qodo-merge-docs.qodo.ai/usage-guide/configuration_options/) 💎 | ✅ | ✅ | | |
| | [PR interactive actions](https://www.qodo.ai/images/pr_agent/pr-actions.mp4) 💎 | ✅ | | | |
| | [Impact Evaluation](https://qodo-merge-docs.qodo.ai/core-abilities/impact_evaluation/) 💎 | ✅ | ✅ | | |
| | [Code Validation 💎](https://qodo-merge-docs.qodo.ai/core-abilities/code_validation/) | ✅ | ✅ | ✅ | ✅ |
| | [Auto Best Practices 💎](https://qodo-merge-docs.qodo.ai/core-abilities/auto_best_practices/) | ✅ | | | |
| | | GitHub | GitLab | Bitbucket | Azure DevOps | Gitea |
| ----- |---------------------------------------------------------------------------------------------------------------------|:------:|:------:|:---------:|:------------:|:-----:|
| [TOOLS](https://qodo-merge-docs.qodo.ai/tools/) | [Describe](https://qodo-merge-docs.qodo.ai/tools/describe/) | ✅ | ✅ | ✅ | ✅ | ✅ |
| | [Review](https://qodo-merge-docs.qodo.ai/tools/review/) | ✅ | ✅ | ✅ | ✅ | ✅ |
| | [Improve](https://qodo-merge-docs.qodo.ai/tools/improve/) | ✅ | ✅ | ✅ | ✅ | ✅ |
| | [Ask](https://qodo-merge-docs.qodo.ai/tools/ask/) | ✅ | ✅ | ✅ | ✅ | |
| | ⮑ [Ask on code lines](https://qodo-merge-docs.qodo.ai/tools/ask/#ask-lines) | ✅ | ✅ | | | |
| | [Help Docs](https://qodo-merge-docs.qodo.ai/tools/help_docs/?h=auto#auto-approval) | ✅ | ✅ | ✅ | | |
| | [Update CHANGELOG](https://qodo-merge-docs.qodo.ai/tools/update_changelog/) | ✅ | ✅ | ✅ | ✅ | |
| | [Add Documentation](https://qodo-merge-docs.qodo.ai/tools/documentation/) 💎 | ✅ | ✅ | | | |
| | [Analyze](https://qodo-merge-docs.qodo.ai/tools/analyze/) 💎 | ✅ | ✅ | | | |
| | [Auto-Approve](https://qodo-merge-docs.qodo.ai/tools/improve/?h=auto#auto-approval) 💎 | ✅ | ✅ | ✅ | | |
| | [CI Feedback](https://qodo-merge-docs.qodo.ai/tools/ci_feedback/) 💎 | ✅ | | | | |
| | [Custom Prompt](https://qodo-merge-docs.qodo.ai/tools/custom_prompt/) 💎 | ✅ | | | | |
| | [Generate Custom Labels](https://qodo-merge-docs.qodo.ai/tools/custom_labels/) 💎 | ✅ | ✅ | | | |
| | [Generate Tests](https://qodo-merge-docs.qodo.ai/tools/test/) 💎 | ✅ | ✅ | | | |
| | [Implement](https://qodo-merge-docs.qodo.ai/tools/implement/) 💎 | ✅ | ✅ | | | |
| | [Scan Repo Discussions](https://qodo-merge-docs.qodo.ai/tools/scan_repo_discussions/) 💎 | ✅ | | | | |
| | [Similar Code](https://qodo-merge-docs.qodo.ai/tools/similar_code/) 💎 | ✅ | | | | |
| | [Ticket Context](https://qodo-merge-docs.qodo.ai/core-abilities/fetching_ticket_context/) 💎 | ✅ | ✅ | | | |
| | [Utilizing Best Practices](https://qodo-merge-docs.qodo.ai/tools/improve/#best-practices) 💎 | ✅ | ✅ | ✅ | | |
| | [PR Chat](https://qodo-merge-docs.qodo.ai/chrome-extension/features/#pr-chat) 💎 | ✅ | | | | |
| | [Suggestion Tracking](https://qodo-merge-docs.qodo.ai/tools/improve/#suggestion-tracking) 💎 | ✅ | ✅ | | | |
| | | | | | | |
| [USAGE](https://qodo-merge-docs.qodo.ai/usage-guide/) | [CLI](https://qodo-merge-docs.qodo.ai/usage-guide/automations_and_usage/#local-repo-cli) | ✅ | ✅ | ✅ | ✅ | ✅ |
| | [App / webhook](https://qodo-merge-docs.qodo.ai/usage-guide/automations_and_usage/#github-app) | ✅ | ✅ | ✅ | ✅ | ✅ |
| | [Tagging bot](https://github.com/Codium-ai/pr-agent#try-it-now) | ✅ | | | | |
| | [Actions](https://qodo-merge-docs.qodo.ai/installation/github/#run-as-a-github-action) | ✅ | ✅ | ✅ | ✅ | |
| | | | | | | |
| [CORE](https://qodo-merge-docs.qodo.ai/core-abilities/) | [Adaptive and token-aware file patch fitting](https://qodo-merge-docs.qodo.ai/core-abilities/compression_strategy/) | ✅ | ✅ | ✅ | ✅ | |
| | [Auto Best Practices 💎](https://qodo-merge-docs.qodo.ai/core-abilities/auto_best_practices/) | | | | | |
| | [Chat on code suggestions](https://qodo-merge-docs.qodo.ai/core-abilities/chat_on_code_suggestions/) | ✅ | ✅ | | | |
| | [Code Validation 💎](https://qodo-merge-docs.qodo.ai/core-abilities/code_validation/) | ✅ | ✅ | ✅ | ✅ | |
| | [Dynamic context](https://qodo-merge-docs.qodo.ai/core-abilities/dynamic_context/) | ✅ | ✅ | ✅ | ✅ | |
| | [Fetching ticket context](https://qodo-merge-docs.qodo.ai/core-abilities/fetching_ticket_context/) | | ✅ | ✅ | | |
| | [Global and wiki configurations](https://qodo-merge-docs.qodo.ai/usage-guide/configuration_options/) 💎 | ✅ | ✅ | | | |
| | [Impact Evaluation](https://qodo-merge-docs.qodo.ai/core-abilities/impact_evaluation/) 💎 | ✅ | ✅ | | | |
| | [Incremental Update 💎](https://qodo-merge-docs.qodo.ai/core-abilities/incremental_update/) | ✅ | | | | |
| | [Interactivity](https://qodo-merge-docs.qodo.ai/core-abilities/interactivity/) | ✅ | ✅ | | | |
| | [Local and global metadata](https://qodo-merge-docs.qodo.ai/core-abilities/metadata/) | ✅ | ✅ | ✅ | ✅ | |
| | [Multiple models support](https://qodo-merge-docs.qodo.ai/usage-guide/changing_a_model/) | ✅ | | | ✅ | |
| | [PR compression](https://qodo-merge-docs.qodo.ai/core-abilities/compression_strategy/) | ✅ | ✅ | ✅ | ✅ | |
| | [PR interactive actions](https://www.qodo.ai/images/pr_agent/pr-actions.mp4) 💎 | ✅ | ✅ | | | |
| | [RAG context enrichment](https://qodo-merge-docs.qodo.ai/core-abilities/rag_context_enrichment/) | ✅ | | ✅ | | |
| | [Self reflection](https://qodo-merge-docs.qodo.ai/core-abilities/self_reflection/) | ✅ | ✅ | ✅ | ✅ | |
| | [Static code analysis](https://qodo-merge-docs.qodo.ai/core-abilities/static_code_analysis/) 💎 | ✅ | ✅ | | | |
!!! note "💎 means Qodo Merge only"
All along the documentation, 💎 marks a feature available only in [Qodo Merge](https://www.codium.ai/pricing/){:target="_blank"}, and not in the open-source version.

View File

@ -0,0 +1,48 @@
## Run a Gitea webhook server
1. In Gitea create a new user and give it "Reporter" role ("Developer" if using Pro version of the agent) for the intended group or project.
2. For the user from step 1. generate a `personal_access_token` with `api` access.
3. Generate a random secret for your app, and save it for later (`webhook_secret`). For example, you can use:
```bash
WEBHOOK_SECRET=$(python -c "import secrets; print(secrets.token_hex(10))")
```
4. Clone this repository:
```bash
git clone https://github.com/qodo-ai/pr-agent.git
```
5. Prepare variables and secrets. Skip this step if you plan on setting these as environment variables when running the agent:
1. In the configuration file/variables:
- Set `config.git_provider` to "gitea"
2. In the secrets file/variables:
- Set your AI model key in the respective section
- In the [Gitea] section, set `personal_access_token` (with token from step 2) and `webhook_secret` (with secret from step 3)
6. Build a Docker image for the app and optionally push it to a Docker repository. We'll use Dockerhub as an example:
```bash
docker build -f /docker/Dockerfile -t pr-agent:gitea_app --target gitea_app .
docker push codiumai/pr-agent:gitea_webhook # Push to your Docker repository
```
7. Set the environmental variables, the method depends on your docker runtime. Skip this step if you included your secrets/configuration directly in the Docker image.
```bash
CONFIG__GIT_PROVIDER=gitea
GITEA__PERSONAL_ACCESS_TOKEN=<personal_access_token>
GITEA__WEBHOOK_SECRET=<webhook_secret>
GITEA__URL=https://gitea.com # Or self host
OPENAI__KEY=<your_openai_api_key>
GITEA__SKIP_SSL_VERIFICATION=false # or true
GITEA__SSL_CA_CERT=/path/to/cacert.pem
```
8. Create a webhook in your Gitea project. Set the URL to `http[s]://<PR_AGENT_HOSTNAME>/api/v1/gitea_webhooks`, the secret token to the generated secret from step 3, and enable the triggers `push`, `comments` and `merge request events`.
9. Test your installation by opening a merge request or commenting on a merge request using one of PR Agent's commands.

View File

@ -187,15 +187,15 @@ For example: `GITHUB.WEBHOOK_SECRET` --> `GITHUB__WEBHOOK_SECRET`
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
# Note: --target github_lambda is optional as it's the default target
docker buildx build --platform=linux/amd64 . -t codiumai/pr-agent:github_lambda --target github_lambda -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
docker tag codiumai/pr-agent:github_lambda <AWS_ACCOUNT>.dkr.ecr.<AWS_REGION>.amazonaws.com/codiumai/pr-agent:github_lambda
docker push <AWS_ACCOUNT>.dkr.ecr.<AWS_REGION>.amazonaws.com/codiumai/pr-agent:github_lambda
```
4. Create a lambda function that uses the uploaded image. Set the lambda timeout to be at least 3m.
@ -204,6 +204,28 @@ For example: `GITHUB.WEBHOOK_SECRET` --> `GITHUB__WEBHOOK_SECRET`
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`
### Using AWS Secrets Manager
For production Lambda deployments, use AWS Secrets Manager instead of environment variables:
1. Create a secret in AWS Secrets Manager with JSON format like this:
```json
{
"openai.key": "sk-proj-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"github.webhook_secret": "your-webhook-secret-from-step-2",
"github.private_key": "-----BEGIN RSA PRIVATE KEY-----\nMIIEpAIBAAKCAQEA...\n-----END RSA PRIVATE KEY-----"
}
```
2. Add IAM permission `secretsmanager:GetSecretValue` to your Lambda execution role
3. Set these environment variables in your Lambda:
```bash
AWS_SECRETS_MANAGER__SECRET_ARN=arn:aws:secretsmanager:us-east-1:123456789012:secret:pr-agent-secrets-AbCdEf
CONFIG__SECRET_PROVIDER=aws_secrets_manager
```
---
## AWS CodeCommit Setup

View File

@ -61,12 +61,12 @@ git clone https://github.com/qodo-ai/pr-agent.git
```
5. Prepare variables and secrets. Skip this step if you plan on setting these as environment variables when running the agent:
1. In the configuration file/variables:
- Set `config.git_provider` to "gitlab"
1. In the configuration file/variables:
- Set `config.git_provider` to "gitlab"
2. In the secrets file/variables:
- Set your AI model key in the respective section
- In the [gitlab] section, set `personal_access_token` (with token from step 2) and `shared_secret` (with secret from step 3)
2. In the secrets file/variables:
- Set your AI model key in the respective section
- In the [gitlab] section, set `personal_access_token` (with token from step 2) and `shared_secret` (with secret from step 3)
6. Build a Docker image for the app and optionally push it to a Docker repository. We'll use Dockerhub as an example:
@ -88,3 +88,63 @@ OPENAI__KEY=<your_openai_api_key>
8. Create a webhook in your GitLab project. Set the URL to `http[s]://<PR_AGENT_HOSTNAME>/webhook`, the secret token to the generated secret from step 3, and enable the triggers `push`, `comments` and `merge request events`.
9. Test your installation by opening a merge request or commenting on a merge request using one of PR Agent's commands.
## Deploy as a Lambda Function
Note that since AWS Lambda env vars cannot have "." in the name, you can replace each "." in an env variable with "__".<br>
For example: `GITLAB.PERSONAL_ACCESS_TOKEN` --> `GITLAB__PERSONAL_ACCESS_TOKEN`
1. Follow steps 1-5 from [Run a GitLab webhook server](#run-a-gitlab-webhook-server).
2. Build a docker image that can be used as a lambda function
```shell
docker buildx build --platform=linux/amd64 . -t codiumai/pr-agent:gitlab_lambda --target gitlab_lambda -f docker/Dockerfile.lambda
```
3. Push image to ECR
```shell
docker tag codiumai/pr-agent:gitlab_lambda <AWS_ACCOUNT>.dkr.ecr.<AWS_REGION>.amazonaws.com/codiumai/pr-agent:gitlab_lambda
docker push <AWS_ACCOUNT>.dkr.ecr.<AWS_REGION>.amazonaws.com/codiumai/pr-agent:gitlab_lambda
```
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 [Run a GitLab webhook server](#run-a-gitlab-webhook-server) with the function url as your Webhook URL.
The Webhook URL would look like `https://<LAMBDA_FUNCTION_URL>/webhook`
### Using AWS Secrets Manager
For production Lambda deployments, use AWS Secrets Manager instead of environment variables:
1. Create individual secrets for each GitLab webhook with this JSON format (e.g., secret name: `project-webhook-secret-001`)
```json
{
"gitlab_token": "glpat-xxxxxxxxxxxxxxxxxxxxxxxx",
"token_name": "project-webhook-001"
}
```
2. Create a main configuration secret for common settings (e.g., secret name: `pr-agent-main-config`)
```json
{
"openai.key": "sk-proj-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
}
```
3. Set these environment variables in your Lambda:
```bash
CONFIG__SECRET_PROVIDER=aws_secrets_manager
AWS_SECRETS_MANAGER__SECRET_ARN=arn:aws:secretsmanager:us-east-1:123456789012:secret:pr-agent-main-config-AbCdEf
```
4. In your GitLab webhook configuration, set the **Secret Token** to the **Secret name** created in step 1:
- Example: `project-webhook-secret-001`
**Important**: When using Secrets Manager, GitLab's webhook secret must be the Secrets Manager secret name.
5. Add IAM permission `secretsmanager:GetSecretValue` to your Lambda execution role

View File

@ -9,6 +9,7 @@ There are several ways to use self-hosted PR-Agent:
- [GitLab integration](./gitlab.md)
- [BitBucket integration](./bitbucket.md)
- [Azure DevOps integration](./azure.md)
- [Gitea integration](./gitea.md)
## Qodo Merge 💎

View File

@ -1,7 +1,7 @@
To run PR-Agent locally, you first need to acquire two keys:
1. An OpenAI key from [here](https://platform.openai.com/api-keys){:target="_blank"}, with access to GPT-4 and o4-mini (or a key for other [language models](https://qodo-merge-docs.qodo.ai/usage-guide/changing_a_model/), if you prefer).
2. A personal access token from your Git platform (GitHub, GitLab, BitBucket) with repo scope. GitHub token, for example, can be issued from [here](https://github.com/settings/tokens){:target="_blank"}
2. A personal access token from your Git platform (GitHub, GitLab, BitBucket,Gitea) with repo scope. GitHub token, for example, can be issued from [here](https://github.com/settings/tokens){:target="_blank"}
## Using Docker image
@ -40,6 +40,19 @@ To invoke a tool (for example `review`), you can run PR-Agent directly from the
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 Gitea:
```bash
docker run --rm -it -e OPENAI.KEY=<your key> -e CONFIG.GIT_PROVIDER=gitea -e GITEA.PERSONAL_ACCESS_TOKEN=<your token> codiumai/pr-agent:latest --pr_url <pr_url> review
```
If you have a dedicated Gitea instance, you need to specify the custom url as variable:
```bash
-e GITEA.URL=<your gitea instance url>
```
For other git providers, update `CONFIG.GIT_PROVIDER` accordingly and check the [`pr_agent/settings/.secrets_template.toml`](https://github.com/Codium-ai/pr-agent/blob/main/pr_agent/settings/.secrets_template.toml) file for environment variables expected names and values.
### Utilizing environment variables

View File

@ -1,20 +1,20 @@
Qodo Merge is a versatile application compatible with GitHub, GitLab, and BitBucket, hosted by QodoAI.
See [here](https://qodo-merge-docs.qodo.ai/overview/pr_agent_pro/) for more details about the benefits of using Qodo Merge.
## Trial Period and Licensing
## Usage and Licensing
### Cloud Users with Teams Account
### Cloud Users
A complimentary two-week trial is provided to all new users (with three additional grace usages). When the trial period ends, users will stop receiving feedback from Qodo Merge.
Non-paying users will enjoy feedback on up to 75 PRs per git organization per month. Above this limit, PRs will not receive feedback until a new month begins.
Following the trial period, user licenses (seats) are required for continued access. Each user requires an individual seat license.
For unlimited access, user licenses (seats) are required. Each user requires an individual seat license.
After purchasing seats, the team owner can assign them to specific users through the management portal.
With an assigned seat, users can seamlessly deploy the application across any of their code repositories.
With an assigned seat, users can seamlessly deploy the application across any of their code repositories in a git organization, and receive feedback on all their PRs.
### Enterprise Account
For organizations who require an Enterprise account, please [contact](https://www.qodo.ai/contact/#pricing) us to initiate a trial period, and to discuss pricing and licensing options.
For companies who require an Enterprise account, please [contact](https://www.qodo.ai/contact/#pricing) us to initiate a trial period, and to discuss pricing and licensing options.
## Install Qodo Merge for GitHub
@ -27,7 +27,9 @@ Qodo Merge for GitHub cloud is available for installation through the [GitHub Ma
### GitHub Enterprise Server
To use Qodo Merge application on your private GitHub Enterprise Server, you will need to [contact](https://www.qodo.ai/contact/#pricing) Qodo for starting an Enterprise trial.
To use Qodo Merge on your private GitHub Enterprise Server, you will need to [contact](https://www.qodo.ai/contact/#pricing) Qodo for starting an Enterprise trial.
(Note: The marketplace app is not compatible with GitHub Enterprise Server. Installation requires creating a private GitHub App instead.)
### GitHub Open Source Projects
@ -95,4 +97,4 @@ Open a new merge request or add a MR comment with one of Qodo Merges commands
### GitLab Server
For a trial period of two weeks on your private GitLab Server, the same [installation steps](#gitlab-cloud) as for GitLab Cloud apply. After the trial period, you will need to [contact](https://www.qodo.ai/contact/#pricing) Qodo for moving to an Enterprise account.
For [limited free usage](https://qodo-merge-docs.qodo.ai/installation/qodo_merge/#cloud-users) on private GitLab Server, the same [installation steps](#gitlab-cloud) as for GitLab Cloud apply. For unlimited usage, you will need to [contact](https://www.qodo.ai/contact/#pricing) Qodo for moving to an Enterprise account.

View File

@ -1,7 +1,12 @@
### Overview
[Qodo Merge](https://www.codium.ai/pricing/){:target="_blank"} is a paid, hosted version of open-source [PR-Agent](https://github.com/Codium-ai/pr-agent){:target="_blank"}. A complimentary two-week trial is offered, followed by a monthly subscription fee.
Qodo Merge is designed for companies and teams that require additional features and capabilities. It provides the following benefits:
[Qodo Merge](https://www.codium.ai/pricing/){:target="_blank"} is a hosted version of the open-source [PR-Agent](https://github.com/Codium-ai/pr-agent){:target="_blank"}.
It is designed for companies and teams that require additional features and capabilities.
Free users receive a quota of 75 monthly PR feedbacks per git organization. Unlimited usage requires a paid subscription. See [details](https://qodo-merge-docs.qodo.ai/installation/qodo_merge/#cloud-users).
Qodo Merge 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 Qodo Merge app to your GitHub\GitLab\BitBucket repo.
@ -45,7 +50,7 @@ Here are additional tools that are available only for Qodo Merge users:
### Supported languages
Qodo Merge leverages the world's leading code models, such as Claude 3.7 Sonnet and o3-mini.
Qodo Merge leverages the world's leading code models, such as Claude 4 Sonnet, o4-mini and Gemini-2.5-Pro.
As a result, its primary tools such as `describe`, `review`, and `improve`, as well as the PR-chat feature, support virtually all programming languages.
For specialized commands that require static code analysis, Qodo Merge offers support for specific languages. For more details about features that require static code analysis, please refer to the [documentation](https://qodo-merge-docs.qodo.ai/tools/analyze/#overview).

View File

@ -2,200 +2,253 @@
## Methodology
Qodo Merge PR Benchmark evaluates and compares the performance of two Large Language Models (LLMs) in analyzing pull request code and providing meaningful code suggestions.
Qodo Merge PR Benchmark evaluates and compares the performance of Large Language Models (LLMs) in analyzing pull request code and providing meaningful code suggestions.
Our diverse dataset comprises of 400 pull requests from over 100 repositories, spanning various programming languages and frameworks to reflect real-world scenarios.
- For each pull request, two distinct LLMs process the same prompt using the Qodo Merge `improve` tool, each generating two sets of responses. The prompt for response generation can be found [here](https://github.com/qodo-ai/pr-agent/blob/main/pr_agent/settings/code_suggestions/pr_code_suggestions_prompts_not_decoupled.toml).
- For each pull request, we have pre-generated suggestions from [11](https://qodo-merge-docs.qodo.ai/pr_benchmark/#models-used-for-generating-the-benchmark-baseline) different top-performing models using the Qodo Merge `improve` tool. The prompt for response generation can be found [here](https://github.com/qodo-ai/pr-agent/blob/main/pr_agent/settings/code_suggestions/pr_code_suggestions_prompts_not_decoupled.toml).
- Subsequently, a high-performing third model (an AI judge) evaluates the responses from the initial two models to determine the superior one. We utilize OpenAI's `o3` model as the judge, though other models have yielded consistent results. The prompt for this comparative judgment is available [here](https://github.com/Codium-ai/pr-agent-settings/tree/main/benchmark).
- To benchmark a model, we generate its suggestions for the same pull requests and ask a high-performing judge model to **rank** the new model's output against the 11 pre-generated baseline suggestions. We utilize OpenAI's `o3` model as the judge, though other models have yielded consistent results. The prompt for this ranking judgment is available [here](https://github.com/Codium-ai/pr-agent-settings/tree/main/benchmark).
- We aggregate comparison outcomes across all the pull requests, calculating the win rate for each model. We also analyze the qualitative feedback (the "why" explanations from the judge) to identify each model's comparative strengths and weaknesses.
- We aggregate ranking outcomes across all pull requests, calculating performance metrics for the evaluated model. We also analyze the qualitative feedback from the judge to identify the model's comparative strengths and weaknesses against the established baselines.
This approach provides not just a quantitative score but also a detailed analysis of each model's strengths and weaknesses.
- For each model we build a "Model Card", comparing it against others. To ensure full transparency and enable community scrutiny, we also share the raw code suggestions generated by each model, and the judge's specific feedback. See example for the full output [here](https://github.com/Codium-ai/pr-agent-settings/blob/main/benchmark/sonnet_37_vs_gemini-2.5-pro-preview-05-06.md)
Note that this benchmark focuses on quality: the ability of an LLM to process complex pull request with multiple files and nuanced task to produce high-quality code suggestions.
Other factors like speed, cost, and availability, while also relevant for model selection, are outside this benchmark's scope.
[//]: # (Note that this benchmark focuses on quality: the ability of an LLM to process complex pull request with multiple files and nuanced task to produce high-quality code suggestions.)
## TL;DR
[//]: # (Other factors like speed, cost, and availability, while also relevant for model selection, are outside this benchmark's scope. We do specify the thinking budget used by each model, which can be a factor in the model's performance.)
Here's a summary of the win rates based on the benchmark:
[//]: # ()
[//]: # (| Model A | Model B | Model A Win Rate | Model B Win Rate |)
[//]: # (|:-------------------------------|:-------------------------------|:----------------:|:----------------:|)
[//]: # (| Gemini-2.5-pro-preview-05-06 | GPT-4.1 | 70.4% | 29.6% |)
[//]: # (| Gemini-2.5-pro-preview-05-06 | Sonnet 3.7 | 78.1% | 21.9% |)
[//]: # (| GPT-4.1 | Sonnet 3.7 | 61.0% | 39.0% |)
## PR Benchmark Results
<table>
<thead>
<tr>
<th style="text-align:left;">Model A</th>
<th style="text-align:left;">Model B</th>
<th style="text-align:center;">Model A Win Rate</th> <th style="text-align:center;">Model B Win Rate</th> </tr>
<th style="text-align:left;">Model Name</th>
<th style="text-align:left;">Version (Date)</th>
<th style="text-align:left;">Thinking budget tokens</th>
<th style="text-align:center;">Score</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align:left;">Gemini-2.5-pro-preview-05-06</td>
<td style="text-align:left;">GPT-4.1</td>
<td style="text-align:center; color: #1E8449;"><b>70.4%</b></td> <td style="text-align:center; color: #D8000C;"><b>29.6%</b></td> </tr>
<td style="text-align:left;">o3</td>
<td style="text-align:left;">2025-04-16</td>
<td style="text-align:left;">'medium' (<a href="https://ai.google.dev/gemini-api/docs/openai">8000</a>)</td>
<td style="text-align:center;"><b>62.5</b></td>
</tr>
<tr>
<td style="text-align:left;">Gemini-2.5-pro-preview-05-06</td>
<td style="text-align:left;">Sonnet 3.7</td>
<td style="text-align:center; color: #1E8449;"><b>78.1%</b></td> <td style="text-align:center; color: #D8000C;"><b>21.9%</b></td> </tr>
<td style="text-align:left;">o4-mini</td>
<td style="text-align:left;">2025-04-16</td>
<td style="text-align:left;">'medium' (<a href="https://ai.google.dev/gemini-api/docs/openai">8000</a>)</td>
<td style="text-align:center;"><b>57.7</b></td>
</tr>
<tr>
<td style="text-align:left;">Gemini-2.5-pro-preview-05-06</td>
<td style="text-align:left;">Gemini-2.5-flash-preview-04-17</td>
<td style="text-align:center; color: #1E8449;"><b>73.0%</b></td> <td style="text-align:center; color: #D8000C;"><b>27.0%</b></td> </tr>
<td style="text-align:left;">Gemini-2.5-pro</td>
<td style="text-align:left;">2025-06-05</td>
<td style="text-align:left;">4096</td>
<td style="text-align:center;"><b>56.3</b></td>
</tr>
<tr>
<td style="text-align:left;">Gemini-2.5-flash-preview-04-17</td>
<td style="text-align:left;">GPT-4.1</td>
<td style="text-align:center; color: #1E8449;"><b>54.6%</b></td> <td style="text-align:center; color: #D8000C;"><b>45.4%</b></td> </tr>
<td style="text-align:left;">Gemini-2.5-pro</td>
<td style="text-align:left;">2025-06-05</td>
<td style="text-align:left;">1024</td>
<td style="text-align:center;"><b>44.3</b></td>
</tr>
<tr>
<td style="text-align:left;">Gemini-2.5-flash-preview-04-17</td>
<td style="text-align:left;">Sonnet 3.7</td>
<td style="text-align:center; color: #1E8449;"><b>60.6%</b></td> <td style="text-align:center; color: #D8000C;"><b>39.4%</b></td> </tr>
<td style="text-align:left;">Claude-4-sonnet</td>
<td style="text-align:left;">2025-05-14</td>
<td style="text-align:left;">4096</td>
<td style="text-align:center;"><b>39.7</b></td>
</tr>
<tr>
<td style="text-align:left;">Claude-4-sonnet</td>
<td style="text-align:left;">2025-05-14</td>
<td style="text-align:left;"></td>
<td style="text-align:center;"><b>39.0</b></td>
</tr>
<tr>
<td style="text-align:left;">Codex-mini</td>
<td style="text-align:left;">2025-06-20</td>
<td style="text-align:left;"><a href="https://platform.openai.com/docs/models/codex-mini-latest">unknown</a></td>
<td style="text-align:center;"><b>37.2</b></td>
</tr>
<tr>
<td style="text-align:left;">Gemini-2.5-flash</td>
<td style="text-align:left;">2025-04-17</td>
<td style="text-align:left;"></td>
<td style="text-align:center;"><b>33.5</b></td>
</tr>
<tr>
<td style="text-align:left;">Claude-3.7-sonnet</td>
<td style="text-align:left;">2025-02-19</td>
<td style="text-align:left;"></td>
<td style="text-align:center;"><b>32.4</b></td>
</tr>
<tr>
<td style="text-align:left;">GPT-4.1</td>
<td style="text-align:left;">Sonnet 3.7</td>
<td style="text-align:center; color: #1E8449;"><b>61.0%</b></td> <td style="text-align:center; color: #D8000C;"><b>39.0%</b></td> </tr>
<td style="text-align:left;">2025-04-14</td>
<td style="text-align:left;"></td>
<td style="text-align:center;"><b>26.5</b></td>
</tr>
</tbody>
</table>
## Results Analysis
## Gemini-2.5-pro-preview-05-06 - Model Card
### O3
### Comparison against GPT-4.1
Final score: **62.5**
![Comparison](https://codium.ai/images/qodo_merge_benchmark/gpt-4.1_vs_gemini-2.5-pro-preview-05-06_judge_o3.png){width=768}
strengths:
#### Analysis Summary
- **High precision & compliance:** Generally respects task rules (limits, “added lines” scope, YAML schema) and avoids false-positive advice, often returning an empty list when appropriate.
- **Clear, actionable output:** Suggestions are concise, well-explained and include correct before/after patches, so reviewers can apply them directly.
- **Good critical-bug detection rate:** Frequently spots compile-breakers or obvious runtime faults (nil / NPE, overflow, race, wrong selector, etc.), putting it at least on par with many peers.
- **Consistent formatting:** Produces syntactically valid YAML with correct labels, making automated consumption easy.
Model 'Gemini-2.5-pro-preview-05-06' is generally more useful thanks to wider and more accurate bug detection and concrete patches, but it sacrifices compliance discipline and sometimes oversteps the task rules. Model 'GPT-4.1' is safer and highly rule-abiding, yet often too timid—missing many genuine issues and providing limited insight. An ideal reviewer would combine 'GPT-4.1 restraint with 'Gemini-2.5-pro-preview-05-06' thoroughness.
weaknesses:
#### Detailed Analysis
- **Narrow coverage:** Tends to stop after 1-2 issues; regularly misses additional critical defects that better answers catch, so it is seldom the top-ranked review.
- **Occasional inaccuracies:** A few replies introduce new bugs, give partial/duplicate fixes, or (rarely) violate rules (e.g., import suggestions), hurting trust.
- **Conservative bias:** Prefers silence over risk; while this keeps precision high, it lowers recall and overall usefulness on larger diffs.
- **Little added insight:** Rarely offers broader context, optimisations or holistic improvements, causing it to rank only mid-tier in many comparisons.
Gemini-2.5-pro-preview-05-06 strengths:
### O4 Mini ('medium' thinking tokens)
- better_bug_coverage: Detects and explains more critical issues, winning in ~70 % of comparisons and achieving a higher average score.
- actionable_fixes: Supplies clear code snippets, correct language labels, and often multiple coherent suggestions per diff.
- deeper_reasoning: Shows stronger grasp of logic, edge cases, and cross-file implications, leading to broader, high-impact reviews.
Final score: **57.7**
Gemini-2.5-pro-preview-05-06 weaknesses:
strengths:
- guideline_violations: More prone to over-eager advice—non-critical tweaks, touching unchanged code, suggesting new imports, or minor format errors.
- occasional_overreach: Some fixes are speculative or risky, potentially introducing new bugs.
- redundant_or_duplicate: At times repeats the same point or exceeds the required brevity.
- **Good rule adherence:** Most answers respect the “new-lines only”, 3-suggestion, and YAML-schema limits, and frequently choose the safe empty list when the diff truly adds no critical bug.
- **Clear, minimal patches:** When the model does spot a defect it usually supplies terse, valid before/after snippets and short, targeted explanations, making fixes easy to read and apply.
- **Language & domain breadth:** Demonstrates competence across many ecosystems (C/C++, Java, TS/JS, Go, Rust, Python, Bash, Markdown, YAML, SQL, CSS, translation files, etc.) and can detect both compile-time and runtime mistakes.
- **Often competitive:** In a sizeable minority of cases the model ties for best or near-best answer, occasionally being the only response to catch a subtle crash or build blocker.
weaknesses:
- **High miss rate:** A large share of examples show the model returning an empty list or only minor advice while other reviewers catch clear, high-impact bugs—indicative of weak defect-detection recall.
- **False or harmful fixes:** Several answers introduce new compilation errors, propose out-of-scope changes, or violate explicit rules (e.g., adding imports, version bumps, touching untouched lines), reducing trustworthiness.
- **Shallow coverage:** Even when it identifies one real issue it often stops there, missing additional critical problems found by stronger peers; breadth and depth are inconsistent.
### Gemini-2.5 Pro (4096 thinking tokens)
Final score: **56.3**
strengths:
- **High formatting compliance:** The model almost always produces valid YAML, respects the three-suggestion limit, and supplies clear before/after code snippets and short rationales.
- **Good “first-bug” detection:** It frequently notices the single most obvious regression (crash, compile error, nil/NPE risk, wrong path, etc.) and gives a minimal, correct patch—often judged “on-par” with other solid answers.
- **Clear, concise writing:** Explanations are brief yet understandable for reviewers; fixes are scoped to the changed lines and rarely include extraneous context.
- **Low rate of harmful fixes:** Truly dangerous or build-breaking advice is rare; most mistakes are omissions rather than wrong code.
weaknesses:
- **Limited breadth of review:** The model regularly stops after the first or second issue, missing additional critical problems that stronger answers surface, so it is often out-ranked by more comprehensive peers.
- **Occasional guideline violations:** A noticeable minority of answers touch unchanged lines, exceed the 3-item cap, suggest adding imports, or drop the required YAML wrapper, leading to automatic downgrades.
- **False positives / speculative fixes:** In several cases it flags non-issues (style, performance, redundant code) or supplies debatable “improvements”, lowering precision and sometimes breaching the “critical bugs only” rule.
- **Inconsistent error coverage:** For certain domains (build scripts, schema files, test code) it either returns an empty list when real regressions exist or proposes cosmetic edits, indicating gaps in specialised knowledge.
### Claude-4 Sonnet (4096 thinking tokens)
Final score: **39.7**
strengths:
- **High guideline & format compliance:** Almost always returns valid YAML, keeps ≤ 3 suggestions, avoids forbidden import/boiler-plate changes and provides clear before/after snippets.
- **Good pinpoint accuracy on single issues:** Frequently spots at least one real critical bug and proposes a concise, technically correct fix that compiles/runs.
- **Clarity & brevity of patches:** Explanations are short, actionable, and focused on changed lines, making the advice easy for reviewers to apply.
weaknesses:
- **Low coverage / recall:** Regularly surfaces only one minor issue (or none) while missing other, often more severe, problems caught by peer models.
- **High “empty-list” rate:** In many diffs the model returns no suggestions even when clear critical bugs exist, offering zero reviewer value.
- **Occasional incorrect or harmful fixes:** A non-trivial number of suggestions are speculative, contradict code intent, or would break compilation/runtime; sometimes duplicates or contradicts itself.
- **Inconsistent severity labelling & duplication:** Repeats the same point in multiple slots, marks cosmetic edits as “critical”, or leaves `improved_code` identical to original.
### Comparison against Sonnet 3.7
### Claude-4 Sonnet
![Comparison](https://codium.ai/images/qodo_merge_benchmark/sonnet_37_vs_gemini-2.5-pro-preview-05-06_judge_o3.png){width=768}
Final score: **39.0**
#### Analysis Summary
strengths:
Model 'Gemini-2.5-pro-preview-05-06' is the stronger reviewer—more frequently identifies genuine, high-impact bugs and provides well-formed, actionable fixes. Model 'Sonnet 3.7' is safer against false positives and tends to be concise but often misses important defects or offers low-value or incorrect suggestions.
- **Consistently well-formatted & rule-compliant output:** Almost every answer follows the required YAML schema, keeps within the 3-suggestion limit, and returns an empty list when no issues are found, showing good instruction following.
See raw results [here](https://github.com/Codium-ai/pr-agent-settings/blob/main/benchmark/sonnet_37_vs_gemini-2.5-pro-preview-05-06.md)
- **Actionable, code-level patches:** When it does spot a defect the model usually supplies clear, minimal diffs or replacement snippets that compile / run, making the fix easy to apply.
- **Decent hit-rate on “obvious” bugs:** The model reliably catches the most blatant syntax errors, null-checks, enum / cast problems, and other first-order issues, so it often ties or slightly beats weaker baseline replies.
weaknesses:
- **Shallow coverage:** It frequently stops after one easy bug and overlooks additional, equally-critical problems that stronger reviewers find, leaving significant risks unaddressed.
- **False positives & harmful fixes:** In a noticeable minority of cases it misdiagnoses code, suggests changes that break compilation or behaviour, or flags non-issues, sometimes making its output worse than doing nothing.
- **Drifts into non-critical or out-of-scope advice:** The model regularly proposes style tweaks, documentation edits, or changes to unchanged lines, violating the “critical new-code only” requirement.
#### Detailed Analysis
### Gemini-2.5 Flash
Gemini-2.5-pro-preview-05-06 strengths:
strengths:
- higher_accuracy_and_coverage: finds real critical bugs and supplies actionable patches in most examples (better in 78 % of cases).
- guideline_awareness: usually respects new-lines-only scope, ≤3 suggestions, proper YAML, and stays silent when no issues exist.
- detailed_reasoning_and_patches: explanations tie directly to the diff and fixes are concrete, often catching multiple related defects that 'Sonnet 3.7' overlooks.
- **High precision / low false-positive rate:** The model often stays silent or gives a single, well-justified fix, so when it does speak the suggestion is usually correct and seldom touches unchanged lines, keeping guideline compliance high.
- **Good guideline awareness:** YAML structure is consistently valid; suggestions rarely exceed the 3-item limit and generally restrict themselves to newly-added lines.
- **Clear, concise patches:** When a defect is found, the model produces short rationales and tidy “improved_code” blocks that reviewers can apply directly.
- **Risk-averse behaviour pays off in “no-bug” PRs:** In examples where the diff truly contained no critical issue, the models empty output ranked above peers that offered speculative or stylistic advice.
Gemini-2.5-pro-preview-05-06 weaknesses:
weaknesses:
- occasional_rule_violations: sometimes proposes new imports, package-version changes, or edits outside the added lines.
- overzealous_suggestions: may add speculative or stylistic fixes that exceed the “critical” scope, or mis-label severity.
- sporadic_technical_slips: a few patches contain minor coding errors, oversized snippets, or duplicate/contradicting advice.
- **Very low recall / shallow coverage:** In a large majority of cases it gives 0-1 suggestions and misses other evident, critical bugs highlighted by peer models, leading to inferior rankings.
- **Occasional incorrect or harmful fixes:** A noticeable subset of answers propose changes that break functionality or misunderstand the code (e.g. bad constant, wrong header logic, speculative rollbacks).
- **Non-actionable placeholders:** Some “improved_code” sections contain comments or “…” rather than real patches, reducing practical value.
## GPT-4.1 - Model Card
### GPT-4.1
### Comparison against Sonnet 3.7
Final score: **26.5**
![Comparison](https://codium.ai/images/qodo_merge_benchmark/gpt-4.1_vs_sonnet_3.7_judge_o3.png){width=768}
strengths:
#### Analysis Summary
- **Consistent format & guideline obedience:** Output is almost always valid YAML, within the 3-suggestion limit, and rarely touches lines not prefixed with “+”.
- **Low false-positive rate:** When no real defect exists, the model correctly returns an empty list instead of inventing speculative fixes, avoiding the “noise” many baseline answers add.
- **Clear, concise patches when it does act:** In the minority of cases where it detects a bug (e.g., ex-13, 46, 212), the fix is usually correct, minimal, and easy to apply.
Model 'GPT-4.1' is safer and more compliant, preferring silence over speculation, which yields fewer rule breaches and false positives but misses some real bugs.
Model 'Sonnet 3.7' is more adventurous and often uncovers important issues that 'GPT-4.1' ignores, yet its aggressive style leads to frequent guideline violations and a higher proportion of incorrect or non-critical advice.
weaknesses:
See raw results [here](https://github.com/Codium-ai/pr-agent-settings/blob/main/benchmark/gpt-4.1_vs_sonnet_3.7_judge_o3.md)
- **Very low recall / coverage:** In a large majority of examples it outputs an empty list or only 1 trivial suggestion while obvious critical issues remain unfixed; it systematically misses circular bugs, null-checks, schema errors, etc.
- **Shallow analysis:** Even when it finds one problem it seldom looks deeper, so more severe or additional bugs in the same diff are left unaddressed.
- **Occasional technical inaccuracies:** A noticeable subset of suggestions are wrong (mis-ordered assertions, harmful Bash `set` change, false dangling-reference claims) or carry metadata errors (mis-labeling files as “python”).
- **Repetitive / derivative fixes:** Many outputs duplicate earlier simplistic ideas (e.g., single null-check) without new insight, showing limited reasoning breadth.
### OpenAI codex-mini
final score: **37.2**
strengths:
- **Can spot high-impact defects:** When it “locks on”, codex-mini often identifies the main runtime or security regression (e.g., race-conditions, logic inversions, blocking I/O, resource leaks) and proposes a minimal, direct patch that compiles and respects neighbouring style.
- **Produces concise, scoped fixes:** Valid answers usually stay within the allowed 3-suggestion limit, reference only the added lines, and contain clear before/after snippets that reviewers can apply verbatim.
- **Occasional broad coverage:** In a minority of cases the model catches multiple independent issues (logic + tests + docs) and outperforms every baseline answer, showing good contextual understanding of heterogeneous diffs.
weaknesses:
- **Output instability / format errors:** A very large share of responses are unusable—plain refusals, shell commands, or malformed/empty YAML—indicating brittle adherence to the required schema and tanking overall usefulness.
- **Critical-miss rate:** Even when the format is correct the model frequently overlooks the single most serious bug the diff introduces, instead focusing on stylistic nits or speculative refactors.
- **Introduces new problems:** Several suggestions add unsupported APIs, undeclared variables, wrong types, or break compilation, hurting trust in the recommendations.
- **Rule violations:** It often edits lines outside the diff, exceeds the 3-suggestion cap, or labels cosmetic tweaks as “critical”, showing inconsistent guideline compliance.
## Appendix - models used for generating the benchmark baseline
- anthropic_sonnet_3.7_v1:0
- claude-4-opus-20250514
- claude-4-sonnet-20250514
- claude-4-sonnet-20250514_thinking_2048
- gemini-2.5-flash-preview-04-17
- gemini-2.5-pro-preview-05-06
- gemini-2.5-pro-preview-06-05_1024
- gemini-2.5-pro-preview-06-05_4096
- gpt-4.1
- o3
- o4-mini_medium
#### Detailed Analysis
GPT-4.1 strengths:
- Strong guideline adherence: usually stays strictly on `+` lines, avoids non-critical or stylistic advice, and rarely suggests forbidden imports; often outputs an empty list when no real bug exists.
- Lower false-positive rate: suggestions are more accurate and seldom introduce new bugs; fixes compile more reliably.
- Good schema discipline: YAML is almost always well-formed and fields are populated correctly.
GPT-4.1 weaknesses:
- Misses bugs: often returns an empty list even when a clear critical issue is present, so coverage is narrower.
- Sparse feedback: when it does comment, it tends to give fewer suggestions and sometimes lacks depth or completeness.
- Occasional metadata/slip-ups (wrong language tags, overly broad code spans), though less harmful than Sonnet 3.7 errors.
### Comparison against Gemini-2.5-pro-preview-05-06
![Comparison](https://codium.ai/images/qodo_merge_benchmark/gpt-4.1_vs_gemini-2.5-pro-preview-05-06_judge_o3.png){width=768}
#### Analysis Summary
Model 'Gemini-2.5-pro-preview-05-06' is generally more useful thanks to wider and more accurate bug detection and concrete patches, but it sacrifices compliance discipline and sometimes oversteps the task rules. Model 'GPT-4.1' is safer and highly rule-abiding, yet often too timid—missing many genuine issues and providing limited insight. An ideal reviewer would combine 'GPT-4.1 restraint with 'Gemini-2.5-pro-preview-05-06' thoroughness.
#### Detailed Analysis
GPT-4.1 strengths:
- strict_compliance: Usually sticks to the “critical bugs only / new + lines only” rule, so outputs rarely violate task constraints.
- low_risk: Conservative behaviour avoids harmful or speculative fixes; safer when no obvious issue exists.
- concise_formatting: Tends to produce minimal, correctly-structured YAML without extra noise.
GPT-4.1 weaknesses:
- under_detection: Frequently returns an empty list even when real bugs are present, missing ~70 % of the time.
- shallow_analysis: When it does suggest fixes, coverage is narrow and technical depth is limited, sometimes with wrong language tags or minor format slips.
- occasional_inaccuracy: A few suggestions are unfounded or duplicate, and rare guideline breaches (e.g., import advice) still occur.
## Sonnet 3.7 - Model Card
### Comparison against GPT-4.1
![Comparison](https://codium.ai/images/qodo_merge_benchmark/gpt-4.1_vs_sonnet_3.7_judge_o3.png){width=768}
#### Analysis Summary
Model 'GPT-4.1' is safer and more compliant, preferring silence over speculation, which yields fewer rule breaches and false positives but misses some real bugs.
Model 'Sonnet 3.7' is more adventurous and often uncovers important issues that 'GPT-4.1' ignores, yet its aggressive style leads to frequent guideline violations and a higher proportion of incorrect or non-critical advice.
See raw results [here](https://github.com/Codium-ai/pr-agent-settings/blob/main/benchmark/gpt-4.1_vs_sonnet_3.7_judge_o3.md)
#### Detailed Analysis
'Sonnet 3.7' strengths:
- Better bug discovery breadth: more willing to dive into logic and spot critical problems that 'GPT-4.1' overlooks; often supplies multiple, detailed fixes.
- Richer explanations & patches: gives fuller context and, when correct, proposes more functional or user-friendly solutions.
- Generally correct language/context tagging and targeted code snippets.
'Sonnet 3.7' weaknesses:
- Guideline violations: frequently flags non-critical issues, edits untouched code, or recommends adding imports, breaching task rules.
- Higher error rate: suggestions are more speculative and sometimes introduce new defects or duplicate work already done.
- Occasional schema or formatting mistakes (missing list value, duplicated suggestions), reducing reliability.
### Comparison against Gemini-2.5-pro-preview-05-06
![Comparison](https://codium.ai/images/qodo_merge_benchmark/sonnet_37_vs_gemini-2.5-pro-preview-05-06_judge_o3.png){width=768}
#### Analysis Summary
Model 'Gemini-2.5-pro-preview-05-06' is the stronger reviewer—more frequently identifies genuine, high-impact bugs and provides well-formed, actionable fixes. Model 'Sonnet 3.7' is safer against false positives and tends to be concise but often misses important defects or offers low-value or incorrect suggestions.
See raw results [here](https://github.com/Codium-ai/pr-agent-settings/blob/main/benchmark/sonnet_37_vs_gemini-2.5-pro-preview-05-06.md)

View File

@ -1,21 +1,21 @@
# Recent Updates and Future Roadmap
`Page last updated: 2025-05-11`
`Page last updated: 2025-07-01`
This page summarizes recent enhancements to Qodo Merge (last three months).
It also outlines our development roadmap for the upcoming three months. Please note that the roadmap is subject to change, and features may be adjusted, added, or reprioritized.
=== "Recent Updates"
- **Chat on Suggestions**: Users can now chat with Qodo Merge code suggestions ([Learn more](https://qodo-merge-docs.qodo.ai/tools/improve/#chat-on-code-suggestions))
- **Scan Repo Discussions Tool**: A new tool that analyzes past code discussions to generate a `best_practices.md` file, distilling key insights and recommendations. ([Learn more](https://qodo-merge-docs.qodo.ai/tools/scan_repo_discussions/))
- **Enhanced Models**: Qodo Merge now defaults to a combination of top models (Claude Sonnet 3.7 and Gemini 2.5 Pro) and incorporates dedicated code validation logic for improved results. ([Details 1](https://qodo-merge-docs.qodo.ai/usage-guide/qodo_merge_models/), [Details 2](https://qodo-merge-docs.qodo.ai/core-abilities/code_validation/))
- **Chrome Extension Update**: Qodo Merge Chrome extension now supports single-tenant users. ([Learn more](https://qodo-merge-docs.qodo.ai/chrome-extension/options/#configuration-options/))
- **Help Docs Tool**: The help_docs tool can answer free-text questions based on any git documentation folder. ([Learn more](https://qodo-merge-docs.qodo.ai/tools/help_docs/))
- **Receiving Qodo Merge feedback locally**: You can receive automatic feedback from Qodo Merge on your local IDE after each commit. ([Learn more](https://github.com/qodo-ai/agents/tree/main/agents/qodo-merge-post-commit)).
- **Mermaid Diagrams**: Qodo Merge now generates by default Mermaid diagrams for PRs, providing a visual representation of code changes. ([Learn more](https://qodo-merge-docs.qodo.ai/tools/describe/#sequence-diagram-support))
- **Best Practices Hierarchy**: Introducing support for structured best practices, such as for folders in monorepos or a unified best practice file for a group of repositories. ([Learn more](https://qodo-merge-docs.qodo.ai/tools/improve/#global-hierarchical-best-practices))
- **Simplified Free Tier**: Qodo Merge now offers a simplified free tier with a monthly limit of 75 PR reviews per organization, replacing the previous two-week trial. ([Learn more](https://qodo-merge-docs.qodo.ai/installation/qodo_merge/#cloud-users))
- **CLI Endpoint**: A new Qodo Merge endpoint that accepts a lists of before/after code changes, executes Qodo Merge commands, and return the results. Currently available for enterprise customers. Contact [Qodo](https://www.qodo.ai/contact/) for more information.
- **Linear tickets support**: Qodo Merge now supports Linear tickets. ([Learn more](https://qodo-merge-docs.qodo.ai/core-abilities/fetching_ticket_context/#linear-integration))
- **Smart Update**: Upon PR updates, Qodo Merge will offer tailored code suggestions, addressing both the entire PR and the specific incremental changes since the last feedback ([Learn more](https://qodo-merge-docs.qodo.ai/core-abilities/incremental_update//))
=== "Future Roadmap"
- **Smart Update**: Upon PR updates, Qodo Merge will offer tailored code suggestions, addressing both the entire PR and the specific incremental changes since the last feedback.
- **CLI Endpoint**: A new Qodo Merge endpoint will accept lists of before/after code changes, execute Qodo Merge commands, and return the results.
- **Simplified Free Tier**: We plan to transition from a two-week free trial to a free tier offering a limited number of suggestions per month per organization.
- **Best Practices Hierarchy**: Introducing support for structured best practices, such as for folders in monorepos or a unified best practice file for a group of repositories.
- **Installation Metrics**: Upon installation, Qodo Merge will analyze past PRs for key metrics (e.g., time to merge, time to first reviewer feedback), enabling pre/post-installation comparison to calculate ROI.
- **Enhanced `review` tool**: Enhancing the `review` tool validate compliance across multiple categories including security, tickets, and custom best practices.
- **Smarter context retrieval**: Leverage AST and LSP analysis to gather relevant context from across the entire repository.
- **Enhanced portal experience**: Improved user experience in the Qodo Merge portal with new options and capabilities.

View File

@ -17,4 +17,4 @@ An example result:
![Analyze 1](https://codium.ai/images/pr_agent/analyze_1.png){width=750}
!!! note "Language that are currently supported:"
Python, Java, C++, JavaScript, TypeScript, C#.
Python, Java, C++, JavaScript, TypeScript, C#, Go.

View File

@ -56,9 +56,31 @@ Everything below this marker is treated as previously auto-generated content and
![Describe comment](https://codium.ai/images/pr_agent/pr_description_user_description.png){width=512}
## Sequence Diagram Support
The `/describe` tool includes a Mermaid sequence diagram showing component/function interactions.
This option is enabled by default via the `pr_description.enable_pr_diagram` param.
[//]: # (### How to enable\disable)
[//]: # ()
[//]: # (In your configuration:)
[//]: # ()
[//]: # (```)
[//]: # (toml)
[//]: # ([pr_description])
[//]: # (enable_pr_diagram = true)
[//]: # (```)
## Configuration options
!!! example "Possible configurations"
???+ example "Possible configurations"
<table>
<tr>
@ -109,6 +131,10 @@ Everything below this marker is treated as previously auto-generated content and
<td><b>enable_help_text</b></td>
<td>If set to true, the tool will display a help text in the comment. Default is false.</td>
</tr>
<tr>
<td><b>enable_pr_diagram</b></td>
<td>If set to true, the tool will generate a horizontal Mermaid flowchart summarizing the main pull request changes. This field remains empty if not applicable. Default is true.</td>
</tr>
</table>
## Inline file summary 💎

View File

@ -26,6 +26,26 @@ You can state a name of a specific component in the PR to get documentation only
/add_docs component_name
```
## Manual triggering
Comment `/add_docs` on a PR to invoke it manually.
## Automatic triggering
To automatically run the `add_docs` tool when a pull request is opened, define in a [configuration file](https://qodo-merge-docs.qodo.ai/usage-guide/configuration_options/):
```toml
[github_app]
pr_commands = [
"/add_docs",
...
]
```
The `pr_commands` list defines commands that run automatically when a PR is opened.
Since this is under the [github_app] section, it only applies when using the Qodo Merge GitHub App in GitHub environments.
## 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`.

View File

@ -7,50 +7,50 @@ It leverages LLM technology to transform PR comments and review suggestions into
## Usage Scenarios
### For Reviewers
=== "For Reviewers"
Reviewers can request code changes by:
Reviewers can request code changes by:
1. Selecting the code block to be modified.
2. Adding a comment with the syntax:
1. Selecting the code block to be modified.
2. Adding a comment with the syntax:
```
/implement <code-change-description>
```
```
/implement <code-change-description>
```
![implement1](https://codium.ai/images/pr_agent/implement1.png){width=640}
![implement1](https://codium.ai/images/pr_agent/implement1.png){width=640}
### For PR Authors
=== "For PR Authors"
PR authors can implement suggested changes by replying to a review comment using either: <br>
PR authors can implement suggested changes by replying to a review comment using either:
1. Add specific implementation details as described above
1. Add specific implementation details as described above
```
/implement <code-change-description>
```
```
/implement <code-change-description>
```
2. Use the original review comment as instructions
2. Use the original review comment as instructions
```
/implement
```
```
/implement
```
![implement2](https://codium.ai/images/pr_agent/implement2.png){width=640}
![implement2](https://codium.ai/images/pr_agent/implement2.png){width=640}
### For Referencing Comments
=== "For Referencing Comments"
You can reference and implement changes from any comment by:
You can reference and implement changes from any comment by:
```
/implement <link-to-review-comment>
```
```
/implement <link-to-review-comment>
```
![implement3](https://codium.ai/images/pr_agent/implement3.png){width=640}
![implement3](https://codium.ai/images/pr_agent/implement3.png){width=640}
Note that the implementation will occur within the review discussion thread.
Note that the implementation will occur within the review discussion thread.
**Configuration options**
## Configuration options
- Use `/implement` to implement code change within and based on the review discussion.
- Use `/implement <code-change-description>` inside a review discussion to implement specific instructions.

View File

@ -144,84 +144,216 @@ Use triple quotes to write multi-line instructions. Use bullet points or numbers
> `💎 feature. Platforms supported: GitHub, GitLab, Bitbucket`
Another option to give additional guidance to the AI model is by creating a `best_practices.md` file in your repository's root directory.
This page can contain a list of best practices, coding standards, and guidelines that are specific to your repo/organization.
Qodo Merge supports both simple and hierarchical best practices configurations to provide guidance to the AI model for generating relevant code suggestions.
The AI model will use this `best_practices.md` file as a reference, and in case the PR code violates any of the guidelines, it will create additional suggestions, with a dedicated label: `Organization
best practice`.
???- tip "Writing effective best practices files"
The following guidelines apply to all best practices files:
- Write clearly and concisely
- Include brief code examples when helpful with before/after patterns
- Focus on project-specific guidelines that will result in relevant suggestions you actually want to get
- Keep each file relatively short, under 800 lines, since:
- AI models may not process effectively very long documents
- Long files tend to contain generic guidelines already known to AI
- Use pattern-based structure rather than simple bullet points for better clarity
Example for a Python `best_practices.md` content:
???- tip "Example of a best practices file"
Pattern 1: Add proper error handling with try-except blocks around external function calls.
Example code before:
```markdown
## Project best practices
- Make sure that I/O operations are encapsulated in a try-except block
- Use the `logging` module for logging instead of `print` statements
- Use `is` and `is not` to compare with `None`
- Use `if __name__ == '__main__':` to run the code only when the script is executed
- Use `with` statement to open files
...
```
```python
# Some code that might raise an exception
return process_pr_data(data)
```
Tips for writing an effective `best_practices.md` file:
Example code after:
- Write clearly and concisely
- Include brief code examples when helpful
- Focus on project-specific guidelines, that will result in relevant suggestions you actually want to get
- Keep the file relatively short, under 800 lines, since:
- AI models may not process effectively very long documents
- Long files tend to contain generic guidelines already known to AI
```python
try:
# Some code that might raise an exception
return process_pr_data(data)
except Exception as e:
logger.exception("Failed to process request", extra={"error": e})
```
To control the number of best practices suggestions generated by the `improve` tool, give the following configuration:
Pattern 2: Add defensive null/empty checks before accessing object properties or performing operations on potentially null variables to prevent runtime errors.
Example code before:
```toml
[best_practices]
num_best_practice_suggestions = 2
```
```python
def get_pr_code(pr_data):
if "changed_code" in pr_data:
return pr_data.get("changed_code", "")
return ""
```
#### Local and global best practices
Example code after:
By default, Qodo Merge will look for a local `best_practices.md` in the root of the relevant local repo.
```python
def get_pr_code(pr_data):
if pr_data is None:
return ""
if "changed_code" in pr_data:
return pr_data.get("changed_code", "")
return ""
```
If you want to enable also a global `best_practices.md` file, set first in the global configuration file:
#### Local best practices
```toml
[best_practices]
enable_global_best_practices = true
```
For basic usage, create a `best_practices.md` file in your repository's root directory containing a list of best practices, coding standards, and guidelines specific to your repository.
Then, create a `best_practices.md` file in the root of [global](https://qodo-merge-docs.qodo.ai/usage-guide/configuration_options/#global-configuration-file) configuration repository, `pr-agent-settings`.
The AI model will use this `best_practices.md` file as a reference, and in case the PR code violates any of the guidelines, it will create additional suggestions, with a dedicated label: `Organization best practice`.
#### Best practices for multiple languages
#### Global hierarchical best practices
For a git organization working with multiple programming languages, you can maintain a centralized global `best_practices.md` file containing language-specific guidelines.
When reviewing pull requests, Qodo Merge automatically identifies the programming language and applies the relevant best practices from this file.
To do this, structure your `best_practices.md` file using the following format:
For organizations managing multiple repositories with different requirements, Qodo Merge supports a hierarchical best practices system using a dedicated global configuration repository.
```
# [Python]
...
# [Java]
...
# [JavaScript]
...
```
**Supported scenarios:**
#### Dedicated label for best practices suggestions
1. **Standalone repositories**: Individual repositories can have their own specific best practices tailored to their unique requirements
2. **Groups of repositories**: Repositories can be mapped to shared group-level best practices for consistent standards across similar projects
3. **Monorepos with subprojects**: Large monorepos can have both repository-level and subproject-level best practices, with automatic path-based matching
Best practice suggestions are labeled as `Organization best practice` by default.
To customize this label, modify it in your configuration file:
#### Setting up global hierarchical best practices
1\. Create a new repository named `pr-agent-settings` in your organization/workspace.
```toml
[best_practices]
organization_name = "..."
```
2\. Build the folder hierarchy in your `pr-agent-settings` repository, for example:
And the label will be: `{organization_name} best practice`.
```bash
pr-agent-settings/
├── metadata.yaml # Maps repos/folders to best practice paths
└── codebase_standards/ # Root for all best practice definitions
├── global/ # Global rules, inherited widely
│ └── best_practices.md
├── groups/ # For groups of repositories
│ ├── frontend_repos/
│ │ └── best_practices.md
│ ├── backend_repos/
│ │ └── best_practices.md
│ └── ...
├── qodo-merge/ # For standalone repositories
│ └── best_practices.md
├── qodo-monorepo/ # For monorepo-specific rules
│ ├── best_practices.md # Root level monorepo rules
│ ├── qodo-github/ # Subproject best practices
│ │ └── best_practices.md
│ └── qodo-gitlab/ # Another subproject
│ └── best_practices.md
└── ... # More repositories
```
#### Example results
3\. Define the metadata file `metadata.yaml` that maps your repositories to their relevant best practices paths, for example:
![best_practice](https://codium.ai/images/pr_agent/org_best_practice.png){width=512}
```yaml
# Standalone repos
qodo-merge:
best_practices_paths:
- "qodo-merge"
# Group-associated repos
repo_b:
best_practices_paths:
- "groups/backend_repos"
# Multi-group repos
repo_c:
best_practices_paths:
- "groups/frontend_repos"
- "groups/backend_repos"
# Monorepo with subprojects
qodo-monorepo:
best_practices_paths:
- "qodo-monorepo"
monorepo_subprojects:
qodo-github:
best_practices_paths:
- "qodo-monorepo/qodo-github"
qodo-gitlab:
best_practices_paths:
- "qodo-monorepo/qodo-gitlab"
```
4\. Set the following configuration in your global configuration file:
```toml
[best_practices]
enable_global_best_practices = true
```
???- info "Best practices priority and fallback behavior"
When global best practices are enabled, Qodo Merge follows this priority order:
1\. **Primary**: Global hierarchical best practices from `pr-agent-settings` repository:
1.1 If the repository is mapped in `metadata.yaml`, it uses the specified paths
1.2 For monorepos, it automatically collects best practices matching PR file paths
1.3 If no mapping exists, it falls back to the global best practices
2\. **Fallback**: Local repository `best_practices.md` file:
2.1 Used when global best practices are not found or configured
2.2 Acts as a safety net for repositories not yet configured in the global system
2.3 Local best practices are completely ignored when global best practices are successfully loaded
???- info "Edge cases and behavior"
- **Missing paths**: If specified paths in `metadata.yaml` don't exist in the file system, those paths are skipped
- **Monorepo subproject matching**: For monorepos, Qodo Merge automatically matches PR file paths against subproject paths to apply relevant best practices
- **Multiple group inheritance**: Repositories can inherit from multiple groups, and all applicable best practices are combined
[//]: # (#### Best practices for multiple languages)
[//]: # ()
[//]: # (For a git organization working with multiple programming languages, you can maintain a centralized global `best_practices.md` file containing language-specific guidelines.)
[//]: # (When reviewing pull requests, Qodo Merge automatically identifies the programming language and applies the relevant best practices from this file.)
[//]: # ()
[//]: # (To do this, structure your `best_practices.md` file using the following format:)
[//]: # ()
[//]: # (```)
[//]: # (# [Python])
[//]: # (...)
[//]: # (# [Java])
[//]: # (...)
[//]: # (# [JavaScript])
[//]: # (...)
[//]: # (```)
???- info "Dedicated label for best practices suggestions"
Best practice suggestions are labeled as `Organization best practice` by default.
To customize this label, modify it in your configuration file:
```toml
[best_practices]
organization_name = "..."
```
And the label will be: `{organization_name} best practice`.
#### Example results
![best_practice](https://codium.ai/images/pr_agent/org_best_practice.png){width=512}
### Auto best practices
@ -288,45 +420,6 @@ We advise users to apply critical analysis and judgment when implementing the pr
In addition to mistakes (which may happen, but are rare), sometimes the presented code modification may serve more as an _illustrative example_ than a directly applicable solution.
In such cases, we recommend prioritizing the suggestion's detailed description, using the diff snippet primarily as a supporting reference.
### Chat on code suggestions
> `💎 feature` Platforms supported: GitHub, GitLab
Qodo Merge implements an orchestrator agent that enables interactive code discussions, listening and responding to comments without requiring explicit tool calls.
The orchestrator intelligently analyzes your responses to determine if you want to implement a suggestion, ask a question, or request help, then delegates to the appropriate specialized tool.
#### Setup and Activation
Enable interactive code discussions by adding the following to your configuration file (default is `True`):
```toml
[pr_code_suggestions]
enable_chat_in_code_suggestions = true
```
!!! info "Activating Dynamic Responses"
To obtain dynamic responses, the following steps are required:
1. Run the `/improve` command (mostly automatic)
2. Tick the `/improve` recommendation checkboxes (_Apply this suggestion_) to have Qodo Merge generate a new inline code suggestion discussion
3. The orchestrator agent will then automatically listen and reply to comments within the discussion without requiring additional commands
#### Explore the available interaction patterns:
!!! tip "Tip: Direct the agent with keywords"
Use "implement" or "apply" for code generation. Use "explain", "why", or "how" for information and help.
=== "Asking for Details"
![Chat on code suggestions ask](https://codium.ai/images/pr_agent/improve_chat_on_code_suggestions_ask.png){width=512}
=== "Implementing Suggestions"
![Chat on code suggestions implement](https://codium.ai/images/pr_agent/improve_chat_on_code_suggestions_implement.png){width=512}
=== "Providing Additional Help"
![Chat on code suggestions help](https://codium.ai/images/pr_agent/improve_chat_on_code_suggestions_help.png){width=512}
### Dual publishing mode
Our recommended approach for presenting code suggestions is through a [table](https://qodo-merge-docs.qodo.ai/tools/improve/#overview) (`--pr_code_suggestions.commitable_code_suggestions=false`).
@ -344,9 +437,26 @@ dual_publishing_score_threshold = x
Where x represents the minimum score threshold (>=) for suggestions to be presented as committable PR comments in addition to the table. Default is -1 (disabled).
### Controlling suggestions depth
> `💎 feature`
You can control the depth and comprehensiveness of the code suggestions by using the `pr_code_suggestions.suggestions_depth` parameter.
Available options:
- `selective` - Shows only suggestions above a score threshold of 6
- `regular` - Default mode with balanced suggestion coverage
- `exhaustive` - Provides maximum suggestion comprehensiveness
(Alternatively, use numeric values: 1, 2, or 3 respectively)
We recommend starting with `regular` mode, then exploring `exhaustive` mode, which can provide more comprehensive suggestions and enhanced bug detection.
### Self-review
> `💎 feature` Platforms supported: GitHub, GitLab
> `💎 feature. Platforms supported: GitHub, GitLab`
If you set in a configuration file:
@ -390,74 +500,6 @@ code_suggestions_self_review_text = "... (your text here) ..."
To prevent unauthorized approvals, this configuration defaults to false, and cannot be altered through online comments; enabling requires a direct update to the configuration file and a commit to the repository. This ensures that utilizing the feature demands a deliberate documented decision by the repository owner.
### Auto-approval
> `💎 feature. Platforms supported: GitHub, GitLab, Bitbucket`
Under specific conditions, Qodo Merge can auto-approve a PR when a specific comment is invoked, or when the PR meets certain criteria.
**To ensure safety, the auto-approval feature is disabled by default.**
To enable auto-approval features, you need to actively set one or both of the following options in a pre-defined _configuration file_:
```toml
[config]
enable_comment_approval = true # For approval via comments
enable_auto_approval = true # For criteria-based auto-approval
```
!!! note "Notes"
- Note that this specific flag cannot be set with a command line argument, only in the configuration file, committed to the repository.
- Enabling auto-approval must be a deliberate decision by the repository owner.
1\. **Auto-approval by commenting**
To enable auto-approval by commenting, set in the configuration file:
```toml
[config]
enable_comment_approval = true
```
After enabling, by commenting on a PR:
```
/review auto_approve
```
Qodo Merge will automatically approve the PR, and add a comment with the approval.
2\. **Auto-approval when the PR meets certain criteria**
To enable auto-approval based on specific criteria, first, you need to enable the top-level flag:
```toml
[config]
enable_auto_approval = true
```
There are two criteria that can be set for auto-approval:
- **Review effort score**
```toml
[config]
enable_auto_approval = true
auto_approve_for_low_review_effort = X # X is a number between 1 to 5
```
When the [review effort score](https://www.qodo.ai/images/pr_agent/review3.png) is lower or equal to X, the PR will be auto-approved.
___
- **No code suggestions**
```toml
[config]
enable_auto_approval = true
auto_approve_for_no_suggestions = true
```
When no [code suggestion](https://www.qodo.ai/images/pr_agent/code_suggestions_as_comment_closed.png) were found for the PR, the PR will be auto-approved.
### How many code suggestions are generated?
@ -481,7 +523,7 @@ Note: Chunking is primarily relevant for large PRs. For most PRs (up to 600 line
## Configuration options
??? example "General options"
???+ example "General options"
<table>
<tr>
@ -496,6 +538,10 @@ Note: Chunking is primarily relevant for large PRs. For most PRs (up to 600 line
<td><b>enable_chat_in_code_suggestions</b></td>
<td>If set to true, QM bot will interact with comments made on code changes it has proposed. Default is true.</td>
</tr>
<tr>
<td><b>suggestions_depth 💎</b></td>
<td> Controls the depth of the suggestions. Can be set to 'selective', 'regular', or 'exhaustive'. Default is 'regular'.</td>
</tr>
<tr>
<td><b>dual_publishing_score_threshold</b></td>
<td>Minimum score threshold for suggestions to be presented as committable PR comments in addition to the table. Default is -1 (disabled).</td>
@ -541,7 +587,7 @@ Note: Chunking is primarily relevant for large PRs. For most PRs (up to 600 line
</tr>
</table>
??? example "Params for number of suggestions and AI calls"
???+ example "Params for number of suggestions and AI calls"
<table>
<tr>

View File

@ -3,22 +3,23 @@
Here is a list of Qodo Merge 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 |
| **[Help (`/help`](./help.md))** | Provides a list of all the available tools. Also enables to trigger them interactively (💎) |
| **[Help Docs (`/help_docs`](./help_docs.md))** | Answer a free-text question based on a git documentation folder. |
| **[Update Changelog (`/update_changelog`](./update_changelog.md))** | Automatically updating the CHANGELOG.md file with the PR changes |
| **💎 [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 |
| **💎 [Test (`/test`](./test.md))** | generate tests for a selected component, based on the PR code changes |
| **💎 [Custom Prompt (`/custom_prompt`](./custom_prompt.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 |
| **💎 [Improve Component (`/improve_component component_name`](./improve_component.md))** | Generates code suggestions for a specific code component that changed in the PR |
| **💎 [CI Feedback (`/checks ci_job`](./ci_feedback.md))** | Automatically generates feedback and analysis for a failed CI job |
| **💎 [Custom Prompt (`/custom_prompt`](./custom_prompt.md))** | Automatically generates custom suggestions for improving the PR code, based on specific guidelines defined by the user |
| **💎 [Generate Custom Labels (`/generate_labels`](./custom_labels.md))** | Generates custom labels for the PR, based on specific guidelines defined by the user |
| **💎 [Generate Tests (`/test`](./test.md))** | Automatically generates unit tests for a selected component, based on the PR code changes |
| **💎 [Implement (`/implement`](./implement.md))** | Generates implementation code from review suggestions |
| **💎 [Improve Component (`/improve_component component_name`](./improve_component.md))** | Generates code suggestions for a specific code component that changed in the PR |
| **💎 [Scan Repo Discussions (`/scan_repo_discussions`](./scan_repo_discussions.md))** | Generates `best_practices.md` file based on previous discussions in the repository |
| **💎 [Similar Code (`/similar_code`](./similar_code.md))** | Retrieves the most similar code components from inside the organization's codebase, or from open-source code. |
Note that the tools marked with 💎 are available only for Qodo Merge users.
Note that the tools marked with 💎 are available only for Qodo Merge users.

View File

@ -51,7 +51,7 @@ extra_instructions = "..."
## Configuration options
!!! example "General options"
???+ example "General options"
<table>
<tr>
@ -70,9 +70,13 @@ extra_instructions = "..."
<td><b>enable_help_text</b></td>
<td>If set to true, the tool will display a help text in the comment. Default is true.</td>
</tr>
<tr>
<td><b>num_max_findings</b></td>
<td>Number of maximum returned findings. Default is 3.</td>
</tr>
</table>
!!! example "Enable\\disable specific sub-sections"
???+ example "Enable\\disable specific sub-sections"
<table>
<tr>
@ -94,6 +98,11 @@ extra_instructions = "..."
<tr>
<td><b>require_security_review</b></td>
<td>If set to true, the tool will add a section that checks if the PR contains a possible security or vulnerability issue. Default is true.</td>
</tr>
<tr>
<td><b>require_todo_scan</b></td>
<td>If set to true, the tool will add a section that lists TODO comments found in the PR code changes. Default is false.
</td>
</tr>
<tr>
<td><b>require_ticket_analysis_review</b></td>
@ -101,7 +110,7 @@ extra_instructions = "..."
</tr>
</table>
!!! example "Adding PR labels"
???+ example "Adding PR labels"
You can enable\disable the `review` tool to add specific labels to the PR:
@ -112,13 +121,15 @@ extra_instructions = "..."
</tr>
<tr>
<td><b>enable_review_labels_effort</b></td>
<td>If set to true, the tool will publish a 'Review effort [1-5]: x' label. Default is true.</td>
<td>If set to true, the tool will publish a 'Review effort x/5' label (15 scale). Default is true.</td>
</tr>
</table>
## Usage Tips
!!! tip "General guidelines"
### General guidelines
!!! tip ""
The `review` tool provides a collection of configurable feedbacks about a PR.
It is recommended to review the [Configuration options](#configuration-options) section, and choose the relevant options for your use case.
@ -128,7 +139,9 @@ extra_instructions = "..."
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.
!!! tip "Automation"
### Automation
!!! tip ""
When you first install Qodo Merge 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", ...]
@ -136,16 +149,30 @@ extra_instructions = "..."
Meaning the `review` tool will run automatically on every PR, without any additional configurations.
Edit this field to enable/disable the tool, or to change the configurations used.
!!! tip "Possible labels from the review tool"
### Auto-generated PR labels by the Review Tool
The `review` tool can auto-generate two specific types of labels for a PR:
!!! tip ""
- a `possible security issue` label that detects if a possible [security issue](https://github.com/Codium-ai/pr-agent/blob/tr/user_description/pr_agent/settings/pr_reviewer_prompts.toml#L136) exists in the PR code (`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)
The `review` can tool automatically add labels to your Pull Requests:
Both modes are useful, and we recommended to enable them.
- **`possible security issue`**: This label is applied if the tool detects a potential [security vulnerability](https://github.com/qodo-ai/pr-agent/blob/main/pr_agent/settings/pr_reviewer_prompts.toml#L103) in the PR's code. This feedback is controlled by the 'enable_review_labels_security' flag (default is true).
- **`review effort [x/5]`**: This label estimates the [effort](https://github.com/qodo-ai/pr-agent/blob/main/pr_agent/settings/pr_reviewer_prompts.toml#L90) required to review the PR on a relative scale of 1 to 5, where 'x' represents the assessed effort. This feedback is controlled by the 'enable_review_labels_effort' flag (default is true).
- **`ticket compliance`**: Adds a label indicating code compliance level ("Fully compliant" | "PR Code Verified" | "Partially compliant" | "Not compliant") to any GitHub/Jira/Linea ticket linked in the PR. Controlled by the 'require_ticket_labels' flag (default: false). If 'require_no_ticket_labels' is also enabled, PRs without ticket links will receive a "No ticket found" label.
!!! tip "Extra instructions"
### Auto-blocking PRs from being merged based on the generated labels
!!! tip ""
You can configure a CI/CD Action to prevent merging PRs with specific labels. For example, implement a dedicated [GitHub Action](https://medium.com/sequra-tech/quick-tip-block-pull-request-merge-using-labels-6cc326936221).
This approach helps ensure PRs with potential security issues or ticket compliance problems will not be merged without further review.
Since AI may make mistakes or lack complete context, use this feature judiciously. For flexibility, users with appropriate permissions can remove generated labels when necessary. When a label is removed, this action will be automatically documented in the PR discussion, clearly indicating it was a deliberate override by an authorized user to allow the merge.
### Extra instructions
!!! tip ""
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.
@ -164,7 +191,3 @@ extra_instructions = "..."
"""
```
Use triple quotes to write multi-line instructions. Use bullet points to make the instructions more readable.
!!! tip "Code suggestions"
The `review` tool previously included a legacy feature for providing code suggestions (controlled by `--pr_reviewer.num_code_suggestion`). This functionality has been deprecated and replaced by the [`improve`](./improve.md) tool, which offers higher quality and more actionable code suggestions.

View File

@ -50,7 +50,7 @@ glob = ['*.py']
And to ignore Python files in all PRs using `regex` pattern, set in a configuration file:
```
[regex]
[ignore]
regex = ['.*\.py$']
```
@ -249,4 +249,16 @@ ignore_pr_authors = ["my-special-bot-user", ...]
Where the `ignore_pr_authors` is a list of usernames that you want to ignore.
!!! note
There is one specific case where bots will receive an automatic response - when they generated a PR with a _failed test_. In that case, the [`ci_feedback`](https://qodo-merge-docs.qodo.ai/tools/ci_feedback/) tool will be invoked.
There is one specific case where bots will receive an automatic response - when they generated a PR with a _failed test_. In that case, the [`ci_feedback`](https://qodo-merge-docs.qodo.ai/tools/ci_feedback/) tool will be invoked.
### Ignoring Generated Files by Language/Framework
To automatically exclude files generated by specific languages or frameworks, you can add the following to your `configuration.toml` file:
```
[config]
ignore_language_framework = ['protobuf', ...]
```
You can view the list of auto-generated file patterns in [`generated_code_ignore.toml`](https://github.com/qodo-ai/pr-agent/blob/main/pr_agent/settings/generated_code_ignore.toml).
Files matching these glob patterns will be automatically excluded from PR Agent analysis.

View File

@ -30,7 +30,7 @@ verbosity_level=2
This is useful for debugging or experimenting with different tools.
3. **git provider**: The [git_provider](https://github.com/Codium-ai/pr-agent/blob/main/pr_agent/settings/configuration.toml#L5) field in a configuration file determines the GIT provider that will be used by Qodo Merge. Currently, the following providers are supported:
`github` **(default)**, `gitlab`, `bitbucket`, `azure`, `codecommit`, `local`, and `gerrit`.
`github` **(default)**, `gitlab`, `bitbucket`, `azure`, `codecommit`, `local`,`gitea`, and `gerrit`.
### CLI Health Check
@ -312,3 +312,16 @@ pr_commands = [
"/improve",
]
```
### Gitea Webhook
After setting up a Gitea webhook, to control which commands will run automatically when a new MR is opened, you can set the `pr_commands` parameter in the configuration file, similar to the GitHub App:
```toml
[gitea]
pr_commands = [
"/describe",
"/review",
"/improve",
]
```

View File

@ -90,7 +90,7 @@ duplicate_examples=true # will duplicate the examples in the prompt, to help the
api_base = "http://localhost:11434" # or whatever port you're running Ollama on
```
By default, Ollama uses a context window size of 2048 tokens. In most cases this is not enough to cover pr-agent promt and pull-request diff. Context window size can be overridden with the `OLLAMA_CONTEXT_LENGTH` environment variable. For example, to set the default context length to 8K, use: `OLLAMA_CONTEXT_LENGTH=8192 ollama serve`. More information you can find on the [official ollama faq](https://github.com/ollama/ollama/blob/main/docs/faq.md#how-can-i-specify-the-context-window-size).
By default, Ollama uses a context window size of 2048 tokens. In most cases this is not enough to cover pr-agent prompt and pull-request diff. Context window size can be overridden with the `OLLAMA_CONTEXT_LENGTH` environment variable. For example, to set the default context length to 8K, use: `OLLAMA_CONTEXT_LENGTH=8192 ollama serve`. More information you can find on the [official ollama faq](https://github.com/ollama/ollama/blob/main/docs/faq.md#how-can-i-specify-the-context-window-size).
Please note that the `custom_model_max_tokens` setting should be configured in accordance with the `OLLAMA_CONTEXT_LENGTH`. Failure to do so may result in unexpected model output.
@ -232,6 +232,14 @@ AWS_SECRET_ACCESS_KEY="..."
AWS_REGION_NAME="..."
```
You can also use the new Meta Llama 4 models available on Amazon Bedrock:
```toml
[config] # in configuration.toml
model="bedrock/us.meta.llama4-scout-17b-instruct-v1:0"
fallback_models=["bedrock/us.meta.llama4-maverick-17b-instruct-v1:0"]
```
See [litellm](https://docs.litellm.ai/docs/providers/bedrock#usage) documentation for more information about the environment variables required for Amazon Bedrock.
### DeepSeek

View File

@ -1,20 +1,22 @@
The different tools and sub-tools used by Qodo Merge are adjustable via the **[configuration file](https://github.com/Codium-ai/pr-agent/blob/main/pr_agent/settings/configuration.toml)**.
The different tools and sub-tools used by Qodo Merge are adjustable via a Git configuration file.
There are three main ways to set persistent configurations:
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://qodo-merge-docs.qodo.ai/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 💎
1. [Wiki](https://qodo-merge-docs.qodo.ai/usage-guide/configuration_options/#wiki-configuration-file) configuration page 💎
2. [Local](https://qodo-merge-docs.qodo.ai/usage-guide/configuration_options/#local-configuration-file) configuration file
3. [Global](https://qodo-merge-docs.qodo.ai/usage-guide/configuration_options/#global-configuration-file) configuration file 💎
In terms of precedence, wiki configurations will override local configurations, and local configurations will override global configurations.
!!! tip "Tip1: edit only what you need"
For a list of all possible configurations, see the [configuration options](https://github.com/qodo-ai/pr-agent/blob/main/pr_agent/settings/configuration.toml/) page.
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.
!!! tip "Tip1: Edit only what you need"
Your configuration file should be minimal, and edit only the relevant values. Don't copy the entire configuration options, since it can lead to legacy problems when something changes.
!!! tip "Tip2: show relevant configurations"
If you set `config.output_relevant_configurations=true`, each tool will also output in a collapsible section its relevant configurations. This can be useful for debugging, or getting to know the configurations better.
!!! tip "Tip2: Show relevant configurations"
If you set `config.output_relevant_configurations` to True, each tool will also output in a collapsible section its relevant configurations. This can be useful for debugging, or getting to know the configurations better.
## Wiki configuration file 💎
@ -86,7 +88,7 @@ Create a dedicated project to hold a global configuration file that affects all
1. Create a new project with both the name and key: PR_AGENT_SETTINGS.
2. Inside the PR_AGENT_SETTINGS project, create a repository named pr-agent-settings.
3. In this repository, add a `.pr_agent.toml` configuration file—structured similarly to the global configuration file described above.
4. Optionally, you can add organizational-level [global best practices file](https://qodo-merge-docs.qodo.ai/usage-guide/configuration_options/#global-configuration-file).
4. Optionally, you can add organizational-level [global best practices](https://qodo-merge-docs.qodo.ai/tools/improve/#global-hierarchical-best-practices).
Repositories across your entire Bitbucket organization will inherit the configuration from this file.

View File

@ -12,6 +12,7 @@ It includes information on how to adjust Qodo Merge configurations, define which
- [GitHub App](./automations_and_usage.md#github-app)
- [GitHub Action](./automations_and_usage.md#github-action)
- [GitLab Webhook](./automations_and_usage.md#gitlab-webhook)
- [Gitea Webhook](./automations_and_usage.md#gitea-webhook)
- [BitBucket App](./automations_and_usage.md#bitbucket-app)
- [Azure DevOps Provider](./automations_and_usage.md#azure-devops-provider)
- [Managing Mail Notifications](./mail_notifications.md)

View File

@ -1,12 +1,12 @@
The default models used by Qodo Merge (April 2025) are a combination of Claude Sonnet 3.7 and Gemini 2.5 Pro.
The default models used by Qodo Merge (June 2025) are a combination of Claude Sonnet 4 and Gemini 2.5 Pro.
### Selecting a Specific Model
Users can configure Qodo Merge to use only a specific model by editing the [configuration](https://qodo-merge-docs.qodo.ai/usage-guide/configuration_options/) file.
The models supported by Qodo Merge are:
- `claude-3-7-sonnet`
- `claude-4-sonnet`
- `o4-mini`
- `gpt-4.1`
- `gemini-2.5-pro`

View File

@ -23,32 +23,35 @@ nav:
- Frequently Asked Questions: 'faq/index.md'
- 💎 Qodo Merge Models: 'usage-guide/qodo_merge_models.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'
- Help Docs: 'tools/help_docs.md'
- Help: 'tools/help.md'
- 💎 Analyze: 'tools/analyze.md'
- 💎 Test: 'tools/test.md'
- 💎 Improve Component: 'tools/improve_component.md'
- 💎 Documentation: 'tools/documentation.md'
- 💎 Custom Labels: 'tools/custom_labels.md'
- 💎 Custom Prompt: 'tools/custom_prompt.md'
- 💎 CI Feedback: 'tools/ci_feedback.md'
- 💎 Similar Code: 'tools/similar_code.md'
- 💎 Implement: 'tools/implement.md'
- 💎 Scan Repo Discussions: 'tools/scan_repo_discussions.md'
- 'tools/index.md'
- Describe: 'tools/describe.md'
- Review: 'tools/review.md'
- Improve: 'tools/improve.md'
- Ask: 'tools/ask.md'
- Help: 'tools/help.md'
- Help Docs: 'tools/help_docs.md'
- Update Changelog: 'tools/update_changelog.md'
- 💎 Add Documentation: 'tools/documentation.md'
- 💎 Analyze: 'tools/analyze.md'
- 💎 CI Feedback: 'tools/ci_feedback.md'
- 💎 Custom Prompt: 'tools/custom_prompt.md'
- 💎 Generate Labels: 'tools/custom_labels.md'
- 💎 Generate Tests: 'tools/test.md'
- 💎 Implement: 'tools/implement.md'
- 💎 Improve Components: 'tools/improve_component.md'
- 💎 Scan Repo Discussions: 'tools/scan_repo_discussions.md'
- 💎 Similar Code: 'tools/similar_code.md'
- Core Abilities:
- 'core-abilities/index.md'
- Auto approval: 'core-abilities/auto_approval.md'
- Auto best practices: 'core-abilities/auto_best_practices.md'
- Chat on code suggestions: 'core-abilities/chat_on_code_suggestions.md'
- Code validation: 'core-abilities/code_validation.md'
- Compression strategy: 'core-abilities/compression_strategy.md'
# - Compression strategy: 'core-abilities/compression_strategy.md'
- Dynamic context: 'core-abilities/dynamic_context.md'
- Fetching ticket context: 'core-abilities/fetching_ticket_context.md'
- Impact evaluation: 'core-abilities/impact_evaluation.md'
- Incremental Update: 'core-abilities/incremental_update.md'
- Interactivity: 'core-abilities/interactivity.md'
- Local and global metadata: 'core-abilities/metadata.md'
- RAG context enrichment: 'core-abilities/rag_context_enrichment.md'

View File

@ -51,7 +51,7 @@ class PRAgent:
def __init__(self, ai_handler: partial[BaseAiHandler,] = LiteLLMAIHandler):
self.ai_handler = ai_handler # will be initialized in run_action
async def handle_request(self, pr_url, request, notify=None) -> bool:
async def _handle_request(self, pr_url, request, notify=None) -> bool:
# First, apply repo specific settings if exists
apply_repo_settings(pr_url)
@ -117,3 +117,10 @@ class PRAgent:
else:
return False
return True
async def handle_request(self, pr_url, request, notify=None) -> bool:
try:
return await self._handle_request(pr_url, request, notify)
except:
get_logger().exception("Failed to process the command.")
return False

View File

@ -53,46 +53,68 @@ MAX_TOKENS = {
'vertex_ai/claude-3-5-haiku@20241022': 100000,
'vertex_ai/claude-3-sonnet@20240229': 100000,
'vertex_ai/claude-3-opus@20240229': 100000,
'vertex_ai/claude-opus-4@20250514': 200000,
'vertex_ai/claude-3-5-sonnet@20240620': 100000,
'vertex_ai/claude-3-5-sonnet-v2@20241022': 100000,
'vertex_ai/claude-3-7-sonnet@20250219': 200000,
'vertex_ai/claude-sonnet-4@20250514': 200000,
'vertex_ai/gemini-1.5-pro': 1048576,
'vertex_ai/gemini-2.5-pro-preview-03-25': 1048576,
'vertex_ai/gemini-2.5-pro-preview-05-06': 1048576,
'vertex_ai/gemini-2.5-pro-preview-06-05': 1048576,
'vertex_ai/gemini-2.5-pro': 1048576,
'vertex_ai/gemini-1.5-flash': 1048576,
'vertex_ai/gemini-2.0-flash': 1048576,
'vertex_ai/gemini-2.5-flash-preview-04-17': 1048576,
'vertex_ai/gemini-2.5-flash-preview-05-20': 1048576,
'vertex_ai/gemini-2.5-flash': 1048576,
'vertex_ai/gemma2': 8200,
'gemini/gemini-1.5-pro': 1048576,
'gemini/gemini-1.5-flash': 1048576,
'gemini/gemini-2.0-flash': 1048576,
'gemini/gemini-2.5-flash-preview-04-17': 1048576,
'gemini/gemini-2.5-flash-preview-05-20': 1048576,
'gemini/gemini-2.5-flash': 1048576,
'gemini/gemini-2.5-pro-preview-03-25': 1048576,
'gemini/gemini-2.5-pro-preview-05-06': 1048576,
'gemini/gemini-2.5-pro-preview-06-05': 1048576,
'gemini/gemini-2.5-pro': 1048576,
'codechat-bison': 6144,
'codechat-bison-32k': 32000,
'anthropic.claude-instant-v1': 100000,
'anthropic.claude-v1': 100000,
'anthropic.claude-v2': 100000,
'anthropic/claude-3-opus-20240229': 100000,
'anthropic/claude-opus-4-20250514': 200000,
'anthropic/claude-3-5-sonnet-20240620': 100000,
'anthropic/claude-3-5-sonnet-20241022': 100000,
'anthropic/claude-3-7-sonnet-20250219': 200000,
'anthropic/claude-sonnet-4-20250514': 200000,
'claude-3-7-sonnet-20250219': 200000,
'anthropic/claude-3-5-haiku-20241022': 100000,
'bedrock/anthropic.claude-instant-v1': 100000,
'bedrock/anthropic.claude-v2': 100000,
'bedrock/anthropic.claude-v2:1': 100000,
'bedrock/anthropic.claude-3-sonnet-20240229-v1:0': 100000,
'bedrock/anthropic.claude-opus-4-20250514-v1:0': 200000,
'bedrock/anthropic.claude-3-haiku-20240307-v1:0': 100000,
'bedrock/anthropic.claude-3-5-haiku-20241022-v1:0': 100000,
'bedrock/anthropic.claude-3-5-sonnet-20240620-v1:0': 100000,
'bedrock/anthropic.claude-3-5-sonnet-20241022-v2:0': 100000,
'bedrock/anthropic.claude-3-7-sonnet-20250219-v1:0': 200000,
'bedrock/anthropic.claude-sonnet-4-20250514-v1:0': 200000,
"bedrock/us.anthropic.claude-opus-4-20250514-v1:0": 200000,
"bedrock/us.anthropic.claude-3-5-sonnet-20241022-v2:0": 100000,
"bedrock/us.anthropic.claude-3-7-sonnet-20250219-v1:0": 200000,
"bedrock/us.anthropic.claude-sonnet-4-20250514-v1:0": 200000,
"bedrock/apac.anthropic.claude-3-5-sonnet-20241022-v2:0": 100000,
"bedrock/apac.anthropic.claude-3-7-sonnet-20250219-v1:0": 200000,
"bedrock/apac.anthropic.claude-sonnet-4-20250514-v1:0": 200000,
'claude-3-5-sonnet': 100000,
'groq/meta-llama/llama-4-scout-17b-16e-instruct': 131072,
'groq/meta-llama/llama-4-maverick-17b-128e-instruct': 131072,
'bedrock/us.meta.llama4-scout-17b-instruct-v1:0': 128000,
'bedrock/us.meta.llama4-maverick-17b-instruct-v1:0': 128000,
'groq/llama3-8b-8192': 8192,
'groq/llama3-70b-8192': 8192,
'groq/llama-3.1-8b-instant': 8192,
@ -102,9 +124,13 @@ MAX_TOKENS = {
'xai/grok-2': 131072,
'xai/grok-2-1212': 131072,
'xai/grok-2-latest': 131072,
'xai/grok-3': 131072,
'xai/grok-3-beta': 131072,
'xai/grok-3-fast': 131072,
'xai/grok-3-fast-beta': 131072,
'xai/grok-3-mini': 131072,
'xai/grok-3-mini-beta': 131072,
'xai/grok-3-mini-fast': 131072,
'xai/grok-3-mini-fast-beta': 131072,
'ollama/llama3': 4096,
'watsonx/meta-llama/llama-3-8b-instruct': 4096,

View File

@ -1,13 +1,17 @@
_LANGCHAIN_INSTALLED = False
try:
from langchain_core.messages import HumanMessage, SystemMessage
from langchain_openai import AzureChatOpenAI, ChatOpenAI
_LANGCHAIN_INSTALLED = True
except: # we don't enforce langchain as a dependency, so if it's not installed, just move on
pass
import functools
from openai import APIError, RateLimitError, Timeout
from retry import retry
import openai
from tenacity import retry, retry_if_exception_type, retry_if_not_exception_type, stop_after_attempt
from langchain_core.runnables import Runnable
from pr_agent.algo.ai_handlers.base_ai_handler import BaseAiHandler
from pr_agent.config_loader import get_settings
@ -18,17 +22,14 @@ OPENAI_RETRIES = 5
class LangChainOpenAIHandler(BaseAiHandler):
def __init__(self):
# Initialize OpenAIHandler specific attributes here
if not _LANGCHAIN_INSTALLED:
error_msg = "LangChain is not installed. Please install it with `pip install langchain`."
get_logger().error(error_msg)
raise ImportError(error_msg)
super().__init__()
self.azure = get_settings().get("OPENAI.API_TYPE", "").lower() == "azure"
# Create a default unused chat object to trigger early validation
self._create_chat(self.deployment_id)
def chat(self, messages: list, model: str, temperature: float):
chat = self._create_chat(self.deployment_id)
return chat.invoke(input=messages, model=model, temperature=temperature)
@property
def deployment_id(self):
"""
@ -36,26 +37,10 @@ class LangChainOpenAIHandler(BaseAiHandler):
"""
return get_settings().get("OPENAI.DEPLOYMENT_ID", None)
@retry(exceptions=(APIError, Timeout, 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
def _create_chat(self, deployment_id=None):
async def _create_chat_async(self, deployment_id=None):
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
# Using Azure OpenAI service
return AzureChatOpenAI(
openai_api_key=get_settings().openai.key,
openai_api_version=get_settings().openai.api_version,
@ -63,14 +48,64 @@ class LangChainOpenAIHandler(BaseAiHandler):
azure_endpoint=get_settings().openai.api_base,
)
else:
# for llms that compatible with openai, should use custom api base
# Using standard OpenAI or other LLM services
openai_api_base = get_settings().get("OPENAI.API_BASE", None)
if openai_api_base is None or len(openai_api_base) == 0:
return ChatOpenAI(openai_api_key=get_settings().openai.key)
else:
return ChatOpenAI(openai_api_key=get_settings().openai.key, openai_api_base=openai_api_base)
return ChatOpenAI(
openai_api_key=get_settings().openai.key,
openai_api_base=openai_api_base
)
except AttributeError as e:
if getattr(e, "name"):
raise ValueError(f"OpenAI {e.name} is required") from e
# Handle configuration errors
error_msg = f"OpenAI {e.name} is required" if getattr(e, "name") else str(e)
get_logger().error(error_msg)
raise ValueError(error_msg) from e
@retry(
retry=retry_if_exception_type(openai.APIError) & retry_if_not_exception_type(openai.RateLimitError),
stop=stop_after_attempt(OPENAI_RETRIES),
)
async def chat_completion(self, model: str, system: str, user: str, temperature: float = 0.2, img_path: str = None):
if img_path:
get_logger().warning(f"Image path is not supported for LangChainOpenAIHandler. Ignoring image path: {img_path}")
try:
messages = [SystemMessage(content=system), HumanMessage(content=user)]
llm = await self._create_chat_async(deployment_id=self.deployment_id)
if not isinstance(llm, Runnable):
error_message = (
f"The Langchain LLM object ({type(llm)}) does not implement the Runnable interface. "
f"Please update your Langchain library to the latest version or "
f"check your LLM configuration to support async calls. "
f"PR-Agent is designed to utilize Langchain's async capabilities."
)
get_logger().error(error_message)
raise NotImplementedError(error_message)
# Handle parameters based on LLM type
if isinstance(llm, (ChatOpenAI, AzureChatOpenAI)):
# OpenAI models support all parameters
resp = await llm.ainvoke(
input=messages,
model=model,
temperature=temperature
)
else:
raise e
# Other LLMs (like Gemini) only support input parameter
get_logger().info(f"Using simplified ainvoke for {type(llm)}")
resp = await llm.ainvoke(input=messages)
finish_reason = "completed"
return resp.content, finish_reason
except openai.RateLimitError as e:
get_logger().error(f"Rate limit error during LLM inference: {e}")
raise
except openai.APIError as e:
get_logger().warning(f"Error during LLM inference: {e}")
raise
except Exception as e:
get_logger().warning(f"Unknown error during LLM inference: {e}")
raise openai.APIError from e

View File

@ -3,7 +3,7 @@ import litellm
import openai
import requests
from litellm import acompletion
from tenacity import retry, retry_if_exception_type, stop_after_attempt
from tenacity import retry, retry_if_exception_type, retry_if_not_exception_type, stop_after_attempt
from pr_agent.algo import CLAUDE_EXTENDED_THINKING_MODELS, NO_SUPPORT_TEMPERATURE_MODELS, SUPPORT_REASONING_EFFORT_MODELS, USER_MESSAGE_ONLY_MODELS
from pr_agent.algo.ai_handlers.base_ai_handler import BaseAiHandler
@ -131,7 +131,7 @@ class LiteLLMAIHandler(BaseAiHandler):
self.api_base = openrouter_api_base
litellm.api_base = openrouter_api_base
# Models that only use user meessage
# Models that only use user message
self.user_message_only_models = USER_MESSAGE_ONLY_MODELS
# Model that doesn't support temperature argument
@ -212,7 +212,7 @@ class LiteLLMAIHandler(BaseAiHandler):
return kwargs
def add_litellm_callbacks(selfs, kwargs) -> dict:
def add_litellm_callbacks(self, kwargs) -> dict:
captured_extra = []
def capture_logs(message):
@ -274,8 +274,8 @@ class LiteLLMAIHandler(BaseAiHandler):
return get_settings().get("OPENAI.DEPLOYMENT_ID", None)
@retry(
retry=retry_if_exception_type((openai.APIError, openai.APIConnectionError, openai.APITimeoutError)), # No retry on RateLimitError
stop=stop_after_attempt(OPENAI_RETRIES)
retry=retry_if_exception_type(openai.APIError) & retry_if_not_exception_type(openai.RateLimitError),
stop=stop_after_attempt(OPENAI_RETRIES),
)
async def chat_completion(self, model: str, system: str, user: str, temperature: float = 0.2, img_path: str = None):
try:
@ -371,13 +371,13 @@ class LiteLLMAIHandler(BaseAiHandler):
get_logger().info(f"\nUser prompt:\n{user}")
response = await acompletion(**kwargs)
except (openai.APIError, openai.APITimeoutError) as e:
get_logger().warning(f"Error during LLM inference: {e}")
raise
except (openai.RateLimitError) as e:
except openai.RateLimitError as e:
get_logger().error(f"Rate limit error during LLM inference: {e}")
raise
except (Exception) as e:
except openai.APIError as e:
get_logger().warning(f"Error during LLM inference: {e}")
raise
except Exception as e:
get_logger().warning(f"Unknown error during LLM inference: {e}")
raise openai.APIError from e
if response is None or len(response["choices"]) == 0:

View File

@ -1,8 +1,8 @@
from os import environ
from pr_agent.algo.ai_handlers.base_ai_handler import BaseAiHandler
import openai
from openai import APIError, AsyncOpenAI, RateLimitError, Timeout
from retry import retry
from openai import AsyncOpenAI
from tenacity import retry, retry_if_exception_type, retry_if_not_exception_type, stop_after_attempt
from pr_agent.algo.ai_handlers.base_ai_handler import BaseAiHandler
from pr_agent.config_loader import get_settings
@ -38,10 +38,14 @@ class OpenAIHandler(BaseAiHandler):
"""
return get_settings().get("OPENAI.DEPLOYMENT_ID", None)
@retry(exceptions=(APIError, Timeout, 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):
@retry(
retry=retry_if_exception_type(openai.APIError) & retry_if_not_exception_type(openai.RateLimitError),
stop=stop_after_attempt(OPENAI_RETRIES),
)
async def chat_completion(self, model: str, system: str, user: str, temperature: float = 0.2, img_path: str = None):
try:
if img_path:
get_logger().warning(f"Image path is not supported for OpenAIHandler. Ignoring image path: {img_path}")
get_logger().info("System: ", system)
get_logger().info("User: ", user)
messages = [{"role": "system", "content": system}, {"role": "user", "content": user}]
@ -57,12 +61,12 @@ class OpenAIHandler(BaseAiHandler):
get_logger().info("AI response", response=resp, messages=messages, finish_reason=finish_reason,
model=model, usage=usage)
return resp, finish_reason
except (APIError, Timeout) as e:
get_logger().error("Error during OpenAI inference: ", e)
except openai.RateLimitError as e:
get_logger().error(f"Rate limit error during LLM 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)
except openai.APIError as e:
get_logger().warning(f"Error during LLM inference: {e}")
raise
except Exception as e:
get_logger().warning(f"Unknown error during LLM inference: {e}")
raise openai.APIError from e

View File

@ -2,6 +2,7 @@ import fnmatch
import re
from pr_agent.config_loader import get_settings
from pr_agent.log import get_logger
def filter_ignored(files, platform = 'github'):
@ -17,7 +18,17 @@ def filter_ignored(files, platform = 'github'):
glob_setting = get_settings().ignore.glob
if isinstance(glob_setting, str): # --ignore.glob=[.*utils.py], --ignore.glob=.*utils.py
glob_setting = glob_setting.strip('[]').split(",")
patterns += [fnmatch.translate(glob) for glob in glob_setting]
patterns += translate_globs_to_regexes(glob_setting)
code_generators = get_settings().config.get('ignore_language_framework', [])
if isinstance(code_generators, str):
get_logger().warning("'ignore_language_framework' should be a list. Skipping language framework filtering.")
code_generators = []
for cg in code_generators:
glob_patterns = get_settings().generated_code.get(cg, [])
if isinstance(glob_patterns, str):
glob_patterns = [glob_patterns]
patterns += translate_globs_to_regexes(glob_patterns)
# compile all valid patterns
compiled_patterns = []
@ -58,8 +69,19 @@ def filter_ignored(files, platform = 'github'):
files = files_o
elif platform == 'azure':
files = [f for f in files if not r.match(f)]
elif platform == 'gitea':
files = [f for f in files if not r.match(f.get("filename", ""))]
except Exception as e:
print(f"Could not filter file list: {e}")
return files
def translate_globs_to_regexes(globs: list):
regexes = []
for pattern in globs:
regexes.append(fnmatch.translate(pattern))
if pattern.startswith("**/"): # cover root-level files
regexes.append(fnmatch.translate(pattern[3:]))
return regexes

View File

@ -1,4 +1,6 @@
from threading import Lock
from math import ceil
import re
from jinja2 import Environment, StrictUndefined
from tiktoken import encoding_for_model, get_encoding
@ -7,6 +9,16 @@ from pr_agent.config_loader import get_settings
from pr_agent.log import get_logger
class ModelTypeValidator:
@staticmethod
def is_openai_model(model_name: str) -> bool:
return 'gpt' in model_name or re.match(r"^o[1-9](-mini|-preview)?$", model_name)
@staticmethod
def is_anthropic_model(model_name: str) -> bool:
return 'claude' in model_name
class TokenEncoder:
_encoder_instance = None
_model = None
@ -40,6 +52,10 @@ class TokenHandler:
method.
"""
# Constants
CLAUDE_MODEL = "claude-3-7-sonnet-20250219"
CLAUDE_MAX_CONTENT_SIZE = 9_000_000 # Maximum allowed content size (9MB) for Claude API
def __init__(self, pr=None, vars: dict = {}, system="", user=""):
"""
Initializes the TokenHandler object.
@ -51,6 +67,7 @@ class TokenHandler:
- user: The user string.
"""
self.encoder = TokenEncoder.get_token_encoder()
if pr is not None:
self.prompt_tokens = self._get_system_user_tokens(pr, self.encoder, vars, system, user)
@ -79,22 +96,22 @@ class TokenHandler:
get_logger().error(f"Error in _get_system_user_tokens: {e}")
return 0
def calc_claude_tokens(self, patch):
def _calc_claude_tokens(self, patch: str) -> int:
try:
import anthropic
from pr_agent.algo import MAX_TOKENS
client = anthropic.Anthropic(api_key=get_settings(use_context=False).get('anthropic.key'))
MaxTokens = MAX_TOKENS[get_settings().config.model]
max_tokens = MAX_TOKENS[get_settings().config.model]
# Check if the content size is too large (9MB limit)
if len(patch.encode('utf-8')) > 9_000_000:
if len(patch.encode('utf-8')) > self.CLAUDE_MAX_CONTENT_SIZE:
get_logger().warning(
"Content too large for Anthropic token counting API, falling back to local tokenizer"
)
return MaxTokens
return max_tokens
response = client.messages.count_tokens(
model="claude-3-7-sonnet-20250219",
model=self.CLAUDE_MODEL,
system="system",
messages=[{
"role": "user",
@ -104,42 +121,51 @@ class TokenHandler:
return response.input_tokens
except Exception as e:
get_logger().error( f"Error in Anthropic token counting: {e}")
return MaxTokens
get_logger().error(f"Error in Anthropic token counting: {e}")
return max_tokens
def estimate_token_count_for_non_anth_claude_models(self, model, default_encoder_estimate):
from math import ceil
import re
def _apply_estimation_factor(self, model_name: str, default_estimate: int) -> int:
factor = 1 + get_settings().get('config.model_token_count_estimate_factor', 0)
get_logger().warning(f"{model_name}'s token count cannot be accurately estimated. Using factor of {factor}")
return ceil(factor * default_estimate)
model_is_from_o_series = re.match(r"^o[1-9](-mini|-preview)?$", model)
if ('gpt' in get_settings().config.model.lower() or model_is_from_o_series) and get_settings(use_context=False).get('openai.key'):
return default_encoder_estimate
#else: Model is not an OpenAI one - therefore, cannot provide an accurate token count and instead, return a higher number as best effort.
def _get_token_count_by_model_type(self, patch: str, default_estimate: int) -> int:
"""
Get token count based on model type.
elbow_factor = 1 + get_settings().get('config.model_token_count_estimate_factor', 0)
get_logger().warning(f"{model}'s expected token count cannot be accurately estimated. Using {elbow_factor} of encoder output as best effort estimate")
return ceil(elbow_factor * default_encoder_estimate)
Args:
patch: The text to count tokens for.
default_estimate: The default token count estimate.
def count_tokens(self, patch: str, force_accurate=False) -> int:
Returns:
int: The calculated token count.
"""
model_name = get_settings().config.model.lower()
if ModelTypeValidator.is_openai_model(model_name) and get_settings(use_context=False).get('openai.key'):
return default_estimate
if ModelTypeValidator.is_anthropic_model(model_name) and get_settings(use_context=False).get('anthropic.key'):
return self._calc_claude_tokens(patch)
return self._apply_estimation_factor(model_name, default_estimate)
def count_tokens(self, patch: str, force_accurate: bool = False) -> int:
"""
Counts the number of tokens in a given patch string.
Args:
- patch: The patch string.
- force_accurate: If True, uses a more precise calculation method.
Returns:
The number of tokens in the patch string.
"""
encoder_estimate = len(self.encoder.encode(patch, disallowed_special=()))
#If an estimate is enough (for example, in cases where the maximal allowed tokens is way below the known limits), return it.
# If an estimate is enough (for example, in cases where the maximal allowed tokens is way below the known limits), return it.
if not force_accurate:
return encoder_estimate
#else, force_accurate==True: User requested providing an accurate estimation:
model = get_settings().config.model.lower()
if 'claude' in model and get_settings(use_context=False).get('anthropic.key'):
return self.calc_claude_tokens(patch) # API call to Anthropic for accurate token counting for Claude models
#else: Non Anthropic provided model:
return self.estimate_token_count_for_non_anth_claude_models(model, encoder_estimate)
return self._get_token_count_by_model_type(patch, encoder_estimate)

View File

@ -1,5 +1,6 @@
from __future__ import annotations
import ast
import copy
import difflib
import hashlib
@ -14,7 +15,7 @@ import traceback
from datetime import datetime
from enum import Enum
from importlib.metadata import PackageNotFoundError, version
from typing import Any, List, Tuple
from typing import Any, List, Tuple, TypedDict
import html2text
import requests
@ -37,21 +38,31 @@ def get_model(model_type: str = "model_weak") -> str:
return get_settings().config.model_reasoning
return get_settings().config.model
class Range(BaseModel):
line_start: int # should be 0-indexed
line_end: int
column_start: int = -1
column_end: int = -1
class ModelType(str, Enum):
REGULAR = "regular"
WEAK = "weak"
REASONING = "reasoning"
class TodoItem(TypedDict):
relevant_file: str
line_range: Tuple[int, int]
content: str
class PRReviewHeader(str, Enum):
REGULAR = "## PR Reviewer Guide"
INCREMENTAL = "## Incremental PR Reviewer Guide"
class ReasoningEffort(str, Enum):
HIGH = "high"
MEDIUM = "medium"
@ -109,6 +120,7 @@ def unique_strings(input_list: List[str]) -> List[str]:
seen.add(item)
return unique_list
def convert_to_markdown_v2(output_data: dict,
gfm_supported: bool = True,
incremental_review=None,
@ -131,6 +143,7 @@ def convert_to_markdown_v2(output_data: dict,
"Focused PR": "",
"Relevant ticket": "🎫",
"Security concerns": "🔒",
"Todo sections": "📝",
"Insights from user's answers": "📝",
"Code feedback": "🤖",
"Estimated effort to review [1-5]": "⏱️",
@ -151,6 +164,7 @@ def convert_to_markdown_v2(output_data: dict,
if gfm_supported:
markdown_text += "<table>\n"
todo_summary = output_data['review'].pop('todo_summary', '')
for key, value in output_data['review'].items():
if value is None or value == '' or value == {} or value == []:
if key.lower() not in ['can_be_split', 'key_issues_to_review']:
@ -209,6 +223,23 @@ def convert_to_markdown_v2(output_data: dict,
markdown_text += f"### {emoji} Security concerns\n\n"
value = emphasize_header(value.strip(), only_markdown=True)
markdown_text += f"{value}\n\n"
elif 'todo sections' in key_nice.lower():
if gfm_supported:
markdown_text += "<tr><td>"
if is_value_no(value):
markdown_text += f"✅&nbsp;<strong>No TODO sections</strong>"
else:
markdown_todo_items = format_todo_items(value, git_provider, gfm_supported)
markdown_text += f"{emoji}&nbsp;<strong>TODO sections</strong>\n<br><br>\n"
markdown_text += markdown_todo_items
markdown_text += "</td></tr>\n"
else:
if is_value_no(value):
markdown_text += f"### ✅ No TODO sections\n\n"
else:
markdown_todo_items = format_todo_items(value, git_provider, gfm_supported)
markdown_text += f"### {emoji} TODO sections\n\n"
markdown_text += markdown_todo_items
elif 'can be split' in key_nice.lower():
if gfm_supported:
markdown_text += f"<tr><td>"
@ -945,12 +976,66 @@ def clip_tokens(text: str, max_tokens: int, add_three_dots=True, num_input_token
"""
Clip the number of tokens in a string to a maximum number of tokens.
This function limits text to a specified token count by calculating the approximate
character-to-token ratio and truncating the text accordingly. A safety factor of 0.9
(10% reduction) is applied to ensure the result stays within the token limit.
Args:
text (str): The string to clip.
text (str): The string to clip. If empty or None, returns the input unchanged.
max_tokens (int): The maximum number of tokens allowed in the string.
add_three_dots (bool, optional): A boolean indicating whether to add three dots at the end of the clipped
If negative, returns an empty string.
add_three_dots (bool, optional): Whether to add "\\n...(truncated)" at the end
of the clipped text to indicate truncation.
Defaults to True.
num_input_tokens (int, optional): Pre-computed number of tokens in the input text.
If provided, skips token encoding step for efficiency.
If None, tokens will be counted using TokenEncoder.
Defaults to None.
delete_last_line (bool, optional): Whether to remove the last line from the
clipped content before adding truncation indicator.
Useful for ensuring clean breaks at line boundaries.
Defaults to False.
Returns:
str: The clipped string.
str: The clipped string. Returns original text if:
- Text is empty/None
- Token count is within limit
- An error occurs during processing
Returns empty string if max_tokens <= 0.
Examples:
Basic usage:
>>> text = "This is a sample text that might be too long"
>>> result = clip_tokens(text, max_tokens=10)
>>> print(result)
This is a sample...
(truncated)
Without truncation indicator:
>>> result = clip_tokens(text, max_tokens=10, add_three_dots=False)
>>> print(result)
This is a sample
With pre-computed token count:
>>> result = clip_tokens(text, max_tokens=5, num_input_tokens=15)
>>> print(result)
This...
(truncated)
With line deletion:
>>> multiline_text = "Line 1\\nLine 2\\nLine 3"
>>> result = clip_tokens(multiline_text, max_tokens=3, delete_last_line=True)
>>> print(result)
Line 1
Line 2
...
(truncated)
Notes:
The function uses a safety factor of 0.9 (10% reduction) to ensure the
result stays within the token limit, as character-to-token ratios can vary.
If token encoding fails, the original text is returned with a warning logged.
"""
if not text:
return text
@ -1235,7 +1320,7 @@ def process_description(description_full: str) -> Tuple[str, List]:
pattern_back = r'<details>\s*<summary><strong>(.*?)</strong><dd><code>(.*?)</code>.*?</summary>\s*<hr>\s*(.*?)\n\n\s*(.*?)</details>'
res = re.search(pattern_back, file_data, re.DOTALL)
if not res or res.lastindex != 4:
pattern_back = r'<details>\s*<summary><strong>(.*?)</strong>\s*<dd><code>(.*?)</code>.*?</summary>\s*<hr>\s*(.*?)\s*-\s*(.*?)\s*</details>' # looking for hypen ('- ')
pattern_back = r'<details>\s*<summary><strong>(.*?)</strong>\s*<dd><code>(.*?)</code>.*?</summary>\s*<hr>\s*(.*?)\s*-\s*(.*?)\s*</details>' # looking for hyphen ('- ')
res = re.search(pattern_back, file_data, re.DOTALL)
if res and res.lastindex == 4:
short_filename = res.group(1).strip()
@ -1313,3 +1398,47 @@ def set_file_languages(diff_files) -> List[FilePatchInfo]:
get_logger().exception(f"Failed to set file languages: {e}")
return diff_files
def format_todo_item(todo_item: TodoItem, git_provider, gfm_supported) -> str:
relevant_file = todo_item.get('relevant_file', '').strip()
line_number = todo_item.get('line_number', '')
content = todo_item.get('content', '')
reference_link = git_provider.get_line_link(relevant_file, line_number, line_number)
file_ref = f"{relevant_file} [{line_number}]"
if reference_link:
if gfm_supported:
file_ref = f"<a href='{reference_link}'>{file_ref}</a>"
else:
file_ref = f"[{file_ref}]({reference_link})"
if content:
return f"{file_ref}: {content.strip()}"
else:
# if content is empty, return only the file reference
return file_ref
def format_todo_items(value: list[TodoItem] | TodoItem, git_provider, gfm_supported) -> str:
markdown_text = ""
MAX_ITEMS = 5 # limit the number of items to display
if gfm_supported:
if isinstance(value, list):
markdown_text += "<ul>\n"
if len(value) > MAX_ITEMS:
get_logger().debug(f"Truncating todo items to {MAX_ITEMS} items")
value = value[:MAX_ITEMS]
for todo_item in value:
markdown_text += f"<li>{format_todo_item(todo_item, git_provider, gfm_supported)}</li>\n"
markdown_text += "</ul>\n"
else:
markdown_text += f"<p>{format_todo_item(value, git_provider, gfm_supported)}</p>\n"
else:
if isinstance(value, list):
if len(value) > MAX_ITEMS:
get_logger().debug(f"Truncating todo items to {MAX_ITEMS} items")
value = value[:MAX_ITEMS]
for todo_item in value:
markdown_text += f"- {format_todo_item(todo_item, git_provider, gfm_supported)}\n"
else:
markdown_text += f"- {format_todo_item(value, git_provider, gfm_supported)}\n"
return markdown_text

View File

@ -14,6 +14,7 @@ global_settings = Dynaconf(
settings_files=[join(current_dir, f) for f in [
"settings/configuration.toml",
"settings/ignore.toml",
"settings/generated_code_ignore.toml",
"settings/language_extensions.toml",
"settings/pr_reviewer_prompts.toml",
"settings/pr_questions_prompts.toml",
@ -81,3 +82,62 @@ def _find_pyproject() -> Optional[Path]:
pyproject_path = _find_pyproject()
if pyproject_path is not None:
get_settings().load_file(pyproject_path, env=f'tool.{PR_AGENT_TOML_KEY}')
def apply_secrets_manager_config():
"""
Retrieve configuration from AWS Secrets Manager and override existing settings
"""
try:
# Dynamic imports to avoid circular dependency (secret_providers imports config_loader)
from pr_agent.secret_providers import get_secret_provider
from pr_agent.log import get_logger
secret_provider = get_secret_provider()
if not secret_provider:
return
if (hasattr(secret_provider, 'get_all_secrets') and
get_settings().get("CONFIG.SECRET_PROVIDER") == 'aws_secrets_manager'):
try:
secrets = secret_provider.get_all_secrets()
if secrets:
apply_secrets_to_config(secrets)
get_logger().info("Applied AWS Secrets Manager configuration")
except Exception as e:
get_logger().error(f"Failed to apply AWS Secrets Manager config: {e}")
except Exception as e:
try:
from pr_agent.log import get_logger
get_logger().debug(f"Secret provider not configured: {e}")
except:
# Fail completely silently if log module is not available
pass
def apply_secrets_to_config(secrets: dict):
"""
Apply secret dictionary to configuration
"""
try:
# Dynamic import to avoid potential circular dependency
from pr_agent.log import get_logger
except:
def get_logger():
class DummyLogger:
def debug(self, msg): pass
return DummyLogger()
for key, value in secrets.items():
if '.' in key: # nested key like "openai.key"
parts = key.split('.')
if len(parts) == 2:
section, setting = parts
section_upper = section.upper()
setting_upper = setting.upper()
# Set only when no existing value (prioritize environment variables)
current_value = get_settings().get(f"{section_upper}.{setting_upper}")
if current_value is None or current_value == "":
get_settings().set(f"{section_upper}.{setting_upper}", value)
get_logger().debug(f"Set {section}.{setting} from AWS Secrets Manager")

View File

@ -8,9 +8,11 @@ from pr_agent.git_providers.bitbucket_server_provider import \
from pr_agent.git_providers.codecommit_provider import CodeCommitProvider
from pr_agent.git_providers.gerrit_provider import GerritProvider
from pr_agent.git_providers.git_provider import GitProvider
from pr_agent.git_providers.gitea_provider import GiteaProvider
from pr_agent.git_providers.github_provider import GithubProvider
from pr_agent.git_providers.gitlab_provider import GitLabProvider
from pr_agent.git_providers.local_git_provider import LocalGitProvider
from pr_agent.git_providers.gitea_provider import GiteaProvider
_GIT_PROVIDERS = {
'github': GithubProvider,
@ -21,6 +23,7 @@ _GIT_PROVIDERS = {
'codecommit': CodeCommitProvider,
'local': LocalGitProvider,
'gerrit': GerritProvider,
'gitea': GiteaProvider
}

View File

@ -22,6 +22,7 @@ try:
from azure.devops.connection import Connection
# noinspection PyUnresolvedReferences
from azure.devops.released.git import (Comment, CommentThread, GitPullRequest, GitVersionDescriptor, GitClient, CommentThreadContext, CommentPosition)
from azure.devops.released.work_item_tracking import WorkItemTrackingClient
# noinspection PyUnresolvedReferences
from azure.identity import DefaultAzureCredential
from msrest.authentication import BasicAuthentication
@ -39,7 +40,7 @@ class AzureDevopsProvider(GitProvider):
"Azure DevOps provider is not available. Please install the required dependencies."
)
self.azure_devops_client = self._get_azure_devops_client()
self.azure_devops_client, self.azure_devops_board_client = self._get_azure_devops_client()
self.diff_files = None
self.workspace_slug = None
self.repo_slug = None
@ -566,7 +567,7 @@ class AzureDevopsProvider(GitProvider):
return workspace_slug, repo_slug, pr_number
@staticmethod
def _get_azure_devops_client() -> GitClient:
def _get_azure_devops_client() -> Tuple[GitClient, WorkItemTrackingClient]:
org = get_settings().azure_devops.get("org", None)
pat = get_settings().azure_devops.get("pat", None)
@ -588,13 +589,12 @@ class AzureDevopsProvider(GitProvider):
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()
azure_devops_board_client = azure_devops_connection.clients.get_work_item_tracking_client()
return azure_devops_client
return azure_devops_client, azure_devops_board_client
def _get_repo(self):
if self.repo is None:
@ -618,7 +618,7 @@ class AzureDevopsProvider(GitProvider):
return pr_id
except Exception as e:
if get_settings().config.verbosity_level >= 2:
get_logger().info(f"Failed to get pr id, error: {e}")
get_logger().info(f"Failed to get PR id, error: {e}")
return ""
def publish_file_comments(self, file_comments: list) -> bool:
@ -635,4 +635,50 @@ class AzureDevopsProvider(GitProvider):
last = commits[0]
url = self.azure_devops_client.normalized_url + "/" + self.workspace_slug + "/_git/" + self.repo_slug + "/commit/" + last.commit_id
return url
def get_linked_work_items(self) -> list:
"""
Get linked work items from the PR.
"""
try:
work_items = self.azure_devops_client.get_pull_request_work_item_refs(
project=self.workspace_slug,
repository_id=self.repo_slug,
pull_request_id=self.pr_num,
)
ids = [work_item.id for work_item in work_items]
if not work_items:
return []
items = self.get_work_items(ids)
return items
except Exception as e:
get_logger().exception(f"Failed to get linked work items, error: {e}")
return []
def get_work_items(self, work_item_ids: list) -> list:
"""
Get work items by their IDs.
"""
try:
raw_work_items = self.azure_devops_board_client.get_work_items(
project=self.workspace_slug,
ids=work_item_ids,
)
work_items = []
for item in raw_work_items:
work_items.append(
{
"id": item.id,
"title": item.fields.get("System.Title", ""),
"url": item.url,
"body": item.fields.get("System.Description", ""),
"acceptance_criteria": item.fields.get(
"Microsoft.VSTS.Common.AcceptanceCriteria", ""
),
"tags": item.fields.get("System.Tags", "").split("; ") if item.fields.get("System.Tags") else [],
}
)
return work_items
except Exception as e:
get_logger().exception(f"Failed to get work items, error: {e}")
return []

View File

@ -86,7 +86,7 @@ class BitbucketServerProvider(GitProvider):
def get_repo_settings(self):
try:
content = self.bitbucket_client.get_content_of_file(self.workspace_slug, self.repo_slug, ".pr_agent.toml", self.get_pr_branch())
content = self.bitbucket_client.get_content_of_file(self.workspace_slug, self.repo_slug, ".pr_agent.toml")
return content
except Exception as e:

View File

@ -0,0 +1,998 @@
import hashlib
import json
from typing import Any, Dict, List, Optional, Set, Tuple
from urllib.parse import urlparse
import giteapy
from giteapy.rest import ApiException
from pr_agent.algo.file_filter import filter_ignored
from pr_agent.algo.language_handler import is_valid_file
from pr_agent.algo.types import EDIT_TYPE
from pr_agent.algo.utils import (clip_tokens,
find_line_number_of_relevant_line_in_file)
from pr_agent.config_loader import get_settings
from pr_agent.git_providers.git_provider import (MAX_FILES_ALLOWED_FULL,
FilePatchInfo, GitProvider,
IncrementalPR)
from pr_agent.log import get_logger
class GiteaProvider(GitProvider):
def __init__(self, url: Optional[str] = None):
super().__init__()
self.logger = get_logger()
if not url:
self.logger.error("PR URL not provided.")
raise ValueError("PR URL not provided.")
self.base_url = get_settings().get("GITEA.URL", "https://gitea.com").rstrip("/")
self.pr_url = ""
self.issue_url = ""
gitea_access_token = get_settings().get("GITEA.PERSONAL_ACCESS_TOKEN", None)
if not gitea_access_token:
self.logger.error("Gitea access token not found in settings.")
raise ValueError("Gitea access token not found in settings.")
self.repo_settings = get_settings().get("GITEA.REPO_SETTING", None)
configuration = giteapy.Configuration()
configuration.host = "{}/api/v1".format(self.base_url)
configuration.api_key['Authorization'] = f'token {gitea_access_token}'
if get_settings().get("GITEA.SKIP_SSL_VERIFICATION", False):
configuration.verify_ssl = False
# Use custom cert (self-signed)
configuration.ssl_ca_cert = get_settings().get("GITEA.SSL_CA_CERT", None)
client = giteapy.ApiClient(configuration)
self.repo_api = RepoApi(client)
self.owner = None
self.repo = None
self.pr_number = None
self.issue_number = None
self.max_comment_chars = 65000
self.enabled_pr = False
self.enabled_issue = False
self.temp_comments = []
self.pr = None
self.git_files = []
self.file_contents = {}
self.file_diffs = {}
self.sha = None
self.diff_files = []
self.incremental = IncrementalPR(False)
self.comments_list = []
self.unreviewed_files_set = dict()
if "pulls" in url:
self.pr_url = url
self.__set_repo_and_owner_from_pr()
self.enabled_pr = True
self.pr = self.repo_api.get_pull_request(
owner=self.owner,
repo=self.repo,
pr_number=self.pr_number
)
self.git_files = self.repo_api.get_change_file_pull_request(
owner=self.owner,
repo=self.repo,
pr_number=self.pr_number
)
# Optional ignore with user custom
self.git_files = filter_ignored(self.git_files, platform="gitea")
self.sha = self.pr.head.sha if self.pr.head.sha else ""
self.__add_file_content()
self.__add_file_diff()
self.pr_commits = self.repo_api.list_all_commits(
owner=self.owner,
repo=self.repo
)
self.last_commit = self.pr_commits[-1]
self.base_sha = self.pr.base.sha if self.pr.base.sha else ""
self.base_ref = self.pr.base.ref if self.pr.base.ref else ""
elif "issues" in url:
self.issue_url = url
self.__set_repo_and_owner_from_issue()
self.enabled_issue = True
else:
self.pr_commits = None
def __add_file_content(self):
for file in self.git_files:
file_path = file.get("filename")
# Ignore file from default settings
if not is_valid_file(file_path):
continue
if file_path and self.sha:
try:
content = self.repo_api.get_file_content(
owner=self.owner,
repo=self.repo,
commit_sha=self.sha,
filepath=file_path
)
self.file_contents[file_path] = content
except ApiException as e:
self.logger.error(f"Error getting file content for {file_path}: {str(e)}")
self.file_contents[file_path] = ""
def __add_file_diff(self):
try:
diff_contents = self.repo_api.get_pull_request_diff(
owner=self.owner,
repo=self.repo,
pr_number=self.pr_number
)
lines = diff_contents.splitlines()
current_file = None
current_patch = []
file_patches = {}
for line in lines:
if line.startswith('diff --git'):
if current_file and current_patch:
file_patches[current_file] = '\n'.join(current_patch)
current_patch = []
current_file = line.split(' b/')[-1]
elif line.startswith('@@'):
current_patch = [line]
elif current_patch:
current_patch.append(line)
if current_file and current_patch:
file_patches[current_file] = '\n'.join(current_patch)
self.file_diffs = file_patches
except Exception as e:
self.logger.error(f"Error getting diff content: {str(e)}")
def _parse_pr_url(self, pr_url: str) -> Tuple[str, str, int]:
parsed_url = urlparse(pr_url)
if parsed_url.path.startswith('/api/v1'):
parsed_url = urlparse(pr_url.replace("/api/v1", ""))
path_parts = parsed_url.path.strip('/').split('/')
if len(path_parts) < 4 or path_parts[2] != 'pulls':
raise ValueError("The provided URL does not appear to be a Gitea PR URL")
try:
pr_number = int(path_parts[3])
except ValueError as e:
raise ValueError("Unable to convert PR number to integer") from e
owner = path_parts[0]
repo = path_parts[1]
return owner, repo, pr_number
def _parse_issue_url(self, issue_url: str) -> Tuple[str, str, int]:
parsed_url = urlparse(issue_url)
if parsed_url.path.startswith('/api/v1'):
parsed_url = urlparse(issue_url.replace("/api/v1", ""))
path_parts = parsed_url.path.strip('/').split('/')
if len(path_parts) < 4 or path_parts[2] != 'issues':
raise ValueError("The provided URL does not appear to be a Gitea issue URL")
try:
issue_number = int(path_parts[3])
except ValueError as e:
raise ValueError("Unable to convert issue number to integer") from e
owner = path_parts[0]
repo = path_parts[1]
return owner, repo, issue_number
def __set_repo_and_owner_from_pr(self):
"""Extract owner and repo from the PR URL"""
try:
owner, repo, pr_number = self._parse_pr_url(self.pr_url)
self.owner = owner
self.repo = repo
self.pr_number = pr_number
self.logger.info(f"Owner: {self.owner}, Repo: {self.repo}, PR Number: {self.pr_number}")
except ValueError as e:
self.logger.error(f"Error parsing PR URL: {str(e)}")
except Exception as e:
self.logger.error(f"Unexpected error: {str(e)}")
def __set_repo_and_owner_from_issue(self):
"""Extract owner and repo from the issue URL"""
try:
owner, repo, issue_number = self._parse_issue_url(self.issue_url)
self.owner = owner
self.repo = repo
self.issue_number = issue_number
self.logger.info(f"Owner: {self.owner}, Repo: {self.repo}, Issue Number: {self.issue_number}")
except ValueError as e:
self.logger.error(f"Error parsing issue URL: {str(e)}")
except Exception as e:
self.logger.error(f"Unexpected error: {str(e)}")
def get_pr_url(self) -> str:
return self.pr_url
def get_issue_url(self) -> str:
return self.issue_url
def publish_comment(self, comment: str,is_temporary: bool = False) -> None:
"""Publish a comment to the pull request"""
if is_temporary and not get_settings().config.publish_output_progress:
get_logger().debug(f"Skipping publish_comment for temporary comment")
return None
if self.enabled_issue:
index = self.issue_number
elif self.enabled_pr:
index = self.pr_number
else:
self.logger.error("Neither PR nor issue URL provided.")
return None
comment = self.limit_output_characters(comment, self.max_comment_chars)
response = self.repo_api.create_comment(
owner=self.owner,
repo=self.repo,
index=index,
comment=comment
)
if not response:
self.logger.error("Failed to publish comment")
return None
if is_temporary:
self.temp_comments.append(comment)
comment_obj = {
"is_temporary": is_temporary,
"comment": comment,
"comment_id": response.id if isinstance(response, tuple) else response.id
}
self.comments_list.append(comment_obj)
self.logger.info("Comment published")
return comment_obj
def edit_comment(self, comment, body : str):
body = self.limit_output_characters(body, self.max_comment_chars)
try:
self.repo_api.edit_comment(
owner=self.owner,
repo=self.repo,
comment_id=comment.get("comment_id") if isinstance(comment, dict) else comment.id,
comment=body
)
except ApiException as e:
self.logger.error(f"Error editing comment: {e}")
return None
except Exception as e:
self.logger.error(f"Unexpected error: {e}")
return None
def publish_inline_comment(self,body: str, relevant_file: str, relevant_line_in_file: str, original_suggestion=None):
"""Publish an inline comment on a specific line"""
body = self.limit_output_characters(body, self.max_comment_chars)
position, absolute_position = find_line_number_of_relevant_line_in_file(self.diff_files,
relevant_file.strip('`'),
relevant_line_in_file,
)
if position == -1:
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()
payload = dict(body=body, path=path, old_position=position,new_position = absolute_position) if subject_type == "LINE" else {}
self.publish_inline_comments([payload])
def publish_inline_comments(self, comments: List[Dict[str, Any]],body : str = "Inline comment") -> None:
response = self.repo_api.create_inline_comment(
owner=self.owner,
repo=self.repo,
pr_number=self.pr_number if self.enabled_pr else self.issue_number,
body=body,
commit_id=self.last_commit.sha if self.last_commit else "",
comments=comments
)
if not response:
self.logger.error("Failed to publish inline comment")
return None
self.logger.info("Inline comment published")
def publish_code_suggestions(self, suggestions: List[Dict[str, Any]]):
"""Publish code suggestions"""
for suggestion in suggestions:
body = suggestion.get("body","")
if not body:
self.logger.error("No body provided for the suggestion")
continue
path = suggestion.get("relevant_file","")
new_position = suggestion.get("relevant_lines_start",0)
old_position = suggestion.get("relevant_lines_start",0) if "original_suggestion" not in suggestion else suggestion["original_suggestion"].get("relevant_lines_start",0)
title_body = suggestion["original_suggestion"].get("suggestion_content","") if "original_suggestion" in suggestion else ""
payload = dict(body=body, path=path, old_position=old_position,new_position = new_position)
if title_body:
title_body = f"**Suggestion:** {title_body}"
self.publish_inline_comments([payload],title_body)
else:
self.publish_inline_comments([payload])
def add_eyes_reaction(self, issue_comment_id: int, disable_eyes: bool = False) -> Optional[int]:
"""Add eyes reaction to a comment"""
try:
if disable_eyes:
return None
comments = self.repo_api.list_all_comments(
owner=self.owner,
repo=self.repo,
index=self.pr_number if self.enabled_pr else self.issue_number
)
comment_ids = [comment.id for comment in comments]
if issue_comment_id not in comment_ids:
self.logger.error(f"Comment ID {issue_comment_id} not found. Available IDs: {comment_ids}")
return None
response = self.repo_api.add_reaction_comment(
owner=self.owner,
repo=self.repo,
comment_id=issue_comment_id,
reaction="eyes"
)
if not response:
self.logger.error("Failed to add eyes reaction")
return None
return response[0].id if isinstance(response, tuple) else response.id
except ApiException as e:
self.logger.error(f"Error adding eyes reaction: {e}")
return None
except Exception as e:
self.logger.error(f"Unexpected error: {e}")
return None
def remove_reaction(self, comment_id: int) -> None:
"""Remove reaction from a comment"""
try:
response = self.repo_api.remove_reaction_comment(
owner=self.owner,
repo=self.repo,
comment_id=comment_id
)
if not response:
self.logger.error("Failed to remove reaction")
except ApiException as e:
self.logger.error(f"Error removing reaction: {e}")
except Exception as e:
self.logger.error(f"Unexpected error: {e}")
def get_commit_messages(self)-> str:
"""Get commit messages for the PR"""
max_tokens = get_settings().get("CONFIG.MAX_COMMITS_TOKENS", None)
pr_commits = self.repo_api.get_pr_commits(
owner=self.owner,
repo=self.repo,
pr_number=self.pr_number
)
if not pr_commits:
self.logger.error("Failed to get commit messages")
return ""
try:
commit_messages = [commit["commit"]["message"] for commit in pr_commits if commit]
if not commit_messages:
self.logger.error("No commit messages found")
return ""
commit_message = "".join(commit_messages)
if max_tokens:
commit_message = clip_tokens(commit_message, max_tokens)
return commit_message
except Exception as e:
self.logger.error(f"Error processing commit messages: {str(e)}")
return ""
def _get_file_content_from_base(self, filename: str) -> str:
return self.repo_api.get_file_content(
owner=self.owner,
repo=self.repo,
commit_sha=self.base_sha,
filepath=filename
)
def _get_file_content_from_latest_commit(self, filename: str) -> str:
return self.repo_api.get_file_content(
owner=self.owner,
repo=self.repo,
commit_sha=self.last_commit.sha,
filepath=filename
)
def get_diff_files(self) -> List[FilePatchInfo]:
"""Get files that were modified in the PR"""
if self.diff_files:
return self.diff_files
invalid_files_names = []
counter_valid = 0
diff_files = []
for file in self.git_files:
filename = file.get("filename")
if not filename:
continue
if not is_valid_file(filename):
invalid_files_names.append(filename)
continue
counter_valid += 1
avoid_load = False
patch = self.file_diffs.get(filename,"")
head_file = ""
base_file = ""
if counter_valid >= MAX_FILES_ALLOWED_FULL and patch and not self.incremental.is_incremental:
avoid_load = True
if counter_valid == MAX_FILES_ALLOWED_FULL:
self.logger.info("Too many files in PR, will avoid loading full content for rest of files")
if avoid_load:
head_file = ""
else:
# Get file content from this pr
head_file = self.file_contents.get(filename,"")
if self.incremental.is_incremental and self.unreviewed_files_set:
base_file = self._get_file_content_from_latest_commit(filename)
self.unreviewed_files_set[filename] = patch
else:
if avoid_load:
base_file = ""
else:
base_file = self._get_file_content_from_base(filename)
num_plus_lines = file.get("additions",0)
num_minus_lines = file.get("deletions",0)
status = file.get("status","")
if status == 'added':
edit_type = EDIT_TYPE.ADDED
elif status == 'removed' or status == 'deleted':
edit_type = EDIT_TYPE.DELETED
elif status == 'renamed':
edit_type = EDIT_TYPE.RENAMED
elif status == 'modified' or status == 'changed':
edit_type = EDIT_TYPE.MODIFIED
else:
self.logger.error(f"Unknown edit type: {status}")
edit_type = EDIT_TYPE.UNKNOWN
file_patch_info = FilePatchInfo(
base_file=base_file,
head_file=head_file,
patch=patch,
filename=filename,
num_minus_lines=num_minus_lines,
num_plus_lines=num_plus_lines,
edit_type=edit_type
)
diff_files.append(file_patch_info)
if invalid_files_names:
self.logger.info(f"Filtered out files with invalid extensions: {invalid_files_names}")
self.diff_files = diff_files
return diff_files
def get_line_link(self, relevant_file, relevant_line_start, relevant_line_end = None) -> str:
if relevant_line_start == -1:
link = f"{self.base_url}/{self.owner}/{self.repo}/src/branch/{self.get_pr_branch()}/{relevant_file}"
elif relevant_line_end:
link = f"{self.base_url}/{self.owner}/{self.repo}/src/branch/{self.get_pr_branch()}/{relevant_file}#L{relevant_line_start}-L{relevant_line_end}"
else:
link = f"{self.base_url}/{self.owner}/{self.repo}/src/branch/{self.get_pr_branch()}/{relevant_file}#L{relevant_line_start}"
self.logger.info(f"Generated link: {link}")
return link
def get_files(self) -> List[Dict[str, Any]]:
"""Get all files in the PR"""
return [file.get("filename","") for file in self.git_files]
def get_num_of_files(self) -> int:
"""Get number of files changed in the PR"""
return len(self.git_files)
def get_issue_comments(self) -> List[Dict[str, Any]]:
"""Get all comments in the PR"""
index = self.issue_number if self.enabled_issue else self.pr_number
comments = self.repo_api.list_all_comments(
owner=self.owner,
repo=self.repo,
index=index
)
if not comments:
self.logger.error("Failed to get comments")
return []
return comments
def get_languages(self) -> Set[str]:
"""Get programming languages used in the repository"""
languages = self.repo_api.get_languages(
owner=self.owner,
repo=self.repo
)
return languages
def get_pr_branch(self) -> str:
"""Get the branch name of the PR"""
if not self.pr:
self.logger.error("Failed to get PR branch")
return ""
if not self.pr.head:
self.logger.error("PR head not found")
return ""
return self.pr.head.ref if self.pr.head.ref else ""
def get_pr_description_full(self) -> str:
"""Get full PR description with metadata"""
if not self.pr:
self.logger.error("Failed to get PR description")
return ""
return self.pr.body if self.pr.body else ""
def get_pr_labels(self,update=False) -> List[str]:
"""Get labels assigned to the PR"""
if not update:
if not self.pr.labels:
self.logger.error("Failed to get PR labels")
return []
return [label.name for label in self.pr.labels]
labels = self.repo_api.get_issue_labels(
owner=self.owner,
repo=self.repo,
issue_number=self.pr_number
)
if not labels:
self.logger.error("Failed to get PR labels")
return []
return [label.name for label in labels]
def get_repo_settings(self) -> str:
"""Get repository settings"""
if not self.repo_settings:
self.logger.error("Repository settings not found")
return ""
response = self.repo_api.get_file_content(
owner=self.owner,
repo=self.repo,
commit_sha=self.sha,
filepath=self.repo_settings
)
if not response:
self.logger.error("Failed to get repository settings")
return ""
return response
def get_user_id(self) -> str:
"""Get the ID of the authenticated user"""
return f"{self.pr.user.id}" if self.pr else ""
def is_supported(self, capability) -> bool:
"""Check if the provider is supported"""
return True
def publish_description(self, pr_title: str, pr_body: str) -> None:
"""Publish PR description"""
response = self.repo_api.edit_pull_request(
owner=self.owner,
repo=self.repo,
pr_number=self.pr_number if self.enabled_pr else self.issue_number,
title=pr_title,
body=pr_body
)
if not response:
self.logger.error("Failed to publish PR description")
return None
self.logger.info("PR description published successfully")
if self.enabled_pr:
self.pr = self.repo_api.get_pull_request(
owner=self.owner,
repo=self.repo,
pr_number=self.pr_number
)
def publish_labels(self, labels: List[int]) -> None:
"""Publish labels to the PR"""
if not labels:
self.logger.error("No labels provided to publish")
return None
response = self.repo_api.add_labels(
owner=self.owner,
repo=self.repo,
issue_number=self.pr_number if self.enabled_pr else self.issue_number,
labels=labels
)
if response:
self.logger.info("Labels added successfully")
def remove_comment(self, comment) -> None:
"""Remove a specific comment"""
if not comment:
return
try:
comment_id = comment.get("comment_id") if isinstance(comment, dict) else comment.id
if not comment_id:
self.logger.error("Comment ID not found")
return None
self.repo_api.remove_comment(
owner=self.owner,
repo=self.repo,
comment_id=comment_id
)
if self.comments_list and comment in self.comments_list:
self.comments_list.remove(comment)
self.logger.info(f"Comment removed successfully: {comment}")
except ApiException as e:
self.logger.error(f"Error removing comment: {e}")
raise e
def remove_initial_comment(self) -> None:
"""Remove the initial comment"""
for comment in self.comments_list:
try:
if not comment.get("is_temporary"):
continue
self.remove_comment(comment)
except Exception as e:
self.logger.error(f"Error removing comment: {e}")
continue
self.logger.info(f"Removed initial comment: {comment.get('comment_id')}")
class RepoApi(giteapy.RepositoryApi):
def __init__(self, client: giteapy.ApiClient):
self.repository = giteapy.RepositoryApi(client)
self.issue = giteapy.IssueApi(client)
self.logger = get_logger()
super().__init__(client)
def create_inline_comment(self, owner: str, repo: str, pr_number: int, body : str ,commit_id : str, comments: List[Dict[str, Any]]) -> None:
body = {
"body": body,
"comments": comments,
"commit_id": commit_id,
}
return self.api_client.call_api(
'/repos/{owner}/{repo}/pulls/{pr_number}/reviews',
'POST',
path_params={'owner': owner, 'repo': repo, 'pr_number': pr_number},
body=body,
response_type='Repository',
auth_settings=['AuthorizationHeaderToken']
)
def create_comment(self, owner: str, repo: str, index: int, comment: str):
body = {
"body": comment
}
return self.issue.issue_create_comment(
owner=owner,
repo=repo,
index=index,
body=body
)
def edit_comment(self, owner: str, repo: str, comment_id: int, comment: str):
body = {
"body": comment
}
return self.issue.issue_edit_comment(
owner=owner,
repo=repo,
id=comment_id,
body=body
)
def remove_comment(self, owner: str, repo: str, comment_id: int):
return self.issue.issue_delete_comment(
owner=owner,
repo=repo,
id=comment_id
)
def list_all_comments(self, owner: str, repo: str, index: int):
return self.issue.issue_get_comments(
owner=owner,
repo=repo,
index=index
)
def get_pull_request_diff(self, owner: str, repo: str, pr_number: int) -> str:
"""Get the diff content of a pull request using direct API call"""
try:
token = self.api_client.configuration.api_key.get('Authorization', '').replace('token ', '')
url = f'/repos/{owner}/{repo}/pulls/{pr_number}.diff'
if token:
url = f'{url}?token={token}'
response = self.api_client.call_api(
url,
'GET',
path_params={},
response_type=None,
_return_http_data_only=False,
_preload_content=False
)
if hasattr(response, 'data'):
raw_data = response.data.read()
return raw_data.decode('utf-8')
elif isinstance(response, tuple):
raw_data = response[0].read()
return raw_data.decode('utf-8')
else:
error_msg = f"Unexpected response format received from API: {type(response)}"
self.logger.error(error_msg)
raise RuntimeError(error_msg)
except ApiException as e:
self.logger.error(f"Error getting diff: {str(e)}")
raise e
except Exception as e:
self.logger.error(f"Unexpected error: {str(e)}")
raise e
def get_pull_request(self, owner: str, repo: str, pr_number: int):
"""Get pull request details including description"""
return self.repository.repo_get_pull_request(
owner=owner,
repo=repo,
index=pr_number
)
def edit_pull_request(self, owner: str, repo: str, pr_number: int,title : str, body: str):
"""Edit pull request description"""
body = {
"body": body,
"title" : title
}
return self.repository.repo_edit_pull_request(
owner=owner,
repo=repo,
index=pr_number,
body=body
)
def get_change_file_pull_request(self, owner: str, repo: str, pr_number: int):
"""Get changed files in the pull request"""
try:
token = self.api_client.configuration.api_key.get('Authorization', '').replace('token ', '')
url = f'/repos/{owner}/{repo}/pulls/{pr_number}/files'
if token:
url = f'{url}?token={token}'
response = self.api_client.call_api(
url,
'GET',
path_params={},
response_type=None,
_return_http_data_only=False,
_preload_content=False
)
if hasattr(response, 'data'):
raw_data = response.data.read()
diff_content = raw_data.decode('utf-8')
return json.loads(diff_content) if isinstance(diff_content, str) else diff_content
elif isinstance(response, tuple):
raw_data = response[0].read()
diff_content = raw_data.decode('utf-8')
return json.loads(diff_content) if isinstance(diff_content, str) else diff_content
return []
except ApiException as e:
self.logger.error(f"Error getting changed files: {e}")
return []
except Exception as e:
self.logger.error(f"Unexpected error: {e}")
return []
def get_languages(self, owner: str, repo: str):
"""Get programming languages used in the repository"""
try:
token = self.api_client.configuration.api_key.get('Authorization', '').replace('token ', '')
url = f'/repos/{owner}/{repo}/languages'
if token:
url = f'{url}?token={token}'
response = self.api_client.call_api(
url,
'GET',
path_params={},
response_type=None,
_return_http_data_only=False,
_preload_content=False
)
if hasattr(response, 'data'):
raw_data = response.data.read()
return json.loads(raw_data.decode('utf-8'))
elif isinstance(response, tuple):
raw_data = response[0].read()
return json.loads(raw_data.decode('utf-8'))
return {}
except ApiException as e:
self.logger.error(f"Error getting languages: {e}")
return {}
except Exception as e:
self.logger.error(f"Unexpected error: {e}")
return {}
def get_file_content(self, owner: str, repo: str, commit_sha: str, filepath: str) -> str:
"""Get raw file content from a specific commit"""
try:
token = self.api_client.configuration.api_key.get('Authorization', '').replace('token ', '')
url = f'/repos/{owner}/{repo}/raw/{filepath}'
if token:
url = f'{url}?token={token}&ref={commit_sha}'
response = self.api_client.call_api(
url,
'GET',
path_params={},
response_type=None,
_return_http_data_only=False,
_preload_content=False
)
if hasattr(response, 'data'):
raw_data = response.data.read()
return raw_data.decode('utf-8')
elif isinstance(response, tuple):
raw_data = response[0].read()
return raw_data.decode('utf-8')
return ""
except ApiException as e:
self.logger.error(f"Error getting file: {filepath}, content: {e}")
return ""
except Exception as e:
self.logger.error(f"Unexpected error: {e}")
return ""
def get_issue_labels(self, owner: str, repo: str, issue_number: int):
"""Get labels assigned to the issue"""
return self.issue.issue_get_labels(
owner=owner,
repo=repo,
index=issue_number
)
def list_all_commits(self, owner: str, repo: str):
return self.repository.repo_get_all_commits(
owner=owner,
repo=repo
)
def add_reviewer(self, owner: str, repo: str, pr_number: int, reviewers: List[str]):
body = {
"reviewers": reviewers
}
return self.api_client.call_api(
'/repos/{owner}/{repo}/pulls/{pr_number}/requested_reviewers',
'POST',
path_params={'owner': owner, 'repo': repo, 'pr_number': pr_number},
body=body,
response_type='Repository',
auth_settings=['AuthorizationHeaderToken']
)
def add_reaction_comment(self, owner: str, repo: str, comment_id: int, reaction: str):
body = {
"content": reaction
}
return self.api_client.call_api(
'/repos/{owner}/{repo}/issues/comments/{id}/reactions',
'POST',
path_params={'owner': owner, 'repo': repo, 'id': comment_id},
body=body,
response_type='Repository',
auth_settings=['AuthorizationHeaderToken']
)
def remove_reaction_comment(self, owner: str, repo: str, comment_id: int):
return self.api_client.call_api(
'/repos/{owner}/{repo}/issues/comments/{id}/reactions',
'DELETE',
path_params={'owner': owner, 'repo': repo, 'id': comment_id},
response_type='Repository',
auth_settings=['AuthorizationHeaderToken']
)
def add_labels(self, owner: str, repo: str, issue_number: int, labels: List[int]):
body = {
"labels": labels
}
return self.issue.issue_add_label(
owner=owner,
repo=repo,
index=issue_number,
body=body
)
def get_pr_commits(self, owner: str, repo: str, pr_number: int):
"""Get all commits in a pull request"""
try:
token = self.api_client.configuration.api_key.get('Authorization', '').replace('token ', '')
url = f'/repos/{owner}/{repo}/pulls/{pr_number}/commits'
if token:
url = f'{url}?token={token}'
response = self.api_client.call_api(
url,
'GET',
path_params={},
response_type=None,
_return_http_data_only=False,
_preload_content=False
)
if hasattr(response, 'data'):
raw_data = response.data.read()
commits_data = json.loads(raw_data.decode('utf-8'))
return commits_data
elif isinstance(response, tuple):
raw_data = response[0].read()
commits_data = json.loads(raw_data.decode('utf-8'))
return commits_data
return []
except ApiException as e:
self.logger.error(f"Error getting PR commits: {e}")
return []
except Exception as e:
self.logger.error(f"Unexpected error: {e}")
return []

View File

@ -96,7 +96,7 @@ class GithubProvider(GitProvider):
parsed_url = urlparse(given_url)
repo_path = (parsed_url.path.split('.git')[0])[1:] # /<owner>/<repo>.git -> <owner>/<repo>
if not repo_path:
get_logger().error(f"url is neither an issues url nor a pr url nor a valid git url: {given_url}. Returning empty result.")
get_logger().error(f"url is neither an issues url nor a PR url nor a valid git url: {given_url}. Returning empty result.")
return ""
return repo_path
except Exception as e:

View File

@ -1,16 +1,17 @@
import difflib
import hashlib
import re
from typing import Optional, Tuple
from urllib.parse import urlparse
from typing import Optional, Tuple, Any, Union
from urllib.parse import urlparse, parse_qs
import gitlab
import requests
from gitlab import GitlabGetError
from gitlab import GitlabGetError, GitlabAuthenticationError, GitlabCreateError, GitlabUpdateError
from pr_agent.algo.types import EDIT_TYPE, FilePatchInfo
from ..algo.file_filter import filter_ignored
from ..algo.git_patch_processing import decode_if_bytes
from ..algo.language_handler import is_valid_file
from ..algo.utils import (clip_tokens,
find_line_number_of_relevant_line_in_file,
@ -112,14 +113,50 @@ class GitLabProvider(GitProvider):
get_logger().error(f"Could not get diff for merge request {self.id_mr}")
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:
try:
return self.gl.projects.get(self.id_project).files.get(file_path, branch).decode()
file_obj = self.gl.projects.get(self.id_project).files.get(file_path, branch)
content = file_obj.decode()
return decode_if_bytes(content)
except GitlabGetError:
# In case of file creation the method returns GitlabGetError (404 file not found).
# In this case we return an empty string for the diff.
return ''
except Exception as e:
get_logger().warning(f"Error retrieving file {file_path} from branch {branch}: {e}")
return ''
def create_or_update_pr_file(self, file_path: str, branch: str, contents="", message="") -> None:
"""Create or update a file in the GitLab repository."""
try:
project = self.gl.projects.get(self.id_project)
if not message:
action = "Update" if contents else "Create"
message = f"{action} {file_path}"
try:
existing_file = project.files.get(file_path, branch)
existing_file.content = contents
existing_file.save(branch=branch, commit_message=message)
get_logger().debug(f"Updated file {file_path} in branch {branch}")
except GitlabGetError:
project.files.create({
'file_path': file_path,
'branch': branch,
'content': contents,
'commit_message': message
})
get_logger().debug(f"Created file {file_path} in branch {branch}")
except GitlabAuthenticationError as e:
get_logger().error(f"Authentication failed while creating/updating file {file_path} in branch {branch}: {e}")
raise
except (GitlabCreateError, GitlabUpdateError) as e:
get_logger().error(f"Permission denied or validation error for file {file_path} in branch {branch}: {e}")
raise
except Exception as e:
get_logger().exception(f"Unexpected error creating/updating file {file_path} in branch {branch}: {e}")
raise
def get_diff_files(self) -> list[FilePatchInfo]:
"""
@ -167,14 +204,9 @@ class GitLabProvider(GitProvider):
original_file_content_str = ''
new_file_content_str = ''
try:
if isinstance(original_file_content_str, bytes):
original_file_content_str = bytes.decode(original_file_content_str, 'utf-8')
if isinstance(new_file_content_str, bytes):
new_file_content_str = bytes.decode(new_file_content_str, 'utf-8')
except UnicodeDecodeError:
get_logger().warning(
f"Cannot decode file {diff['old_path']} or {diff['new_path']} in merge request {self.id_mr}")
# Ensure content is properly decoded
original_file_content_str = decode_if_bytes(original_file_content_str)
new_file_content_str = decode_if_bytes(new_file_content_str)
edit_type = EDIT_TYPE.MODIFIED
if diff['new_file']:

View File

@ -13,5 +13,12 @@ def get_secret_provider():
return GoogleCloudStorageSecretProvider()
except Exception as e:
raise ValueError(f"Failed to initialize google_cloud_storage secret provider {provider_id}") from e
elif provider_id == 'aws_secrets_manager':
try:
from pr_agent.secret_providers.aws_secrets_manager_provider import \
AWSSecretsManagerProvider
return AWSSecretsManagerProvider()
except Exception as e:
raise ValueError(f"Failed to initialize aws_secrets_manager secret provider {provider_id}") from e
else:
raise ValueError("Unknown SECRET_PROVIDER")

View File

@ -0,0 +1,57 @@
import json
import boto3
from botocore.exceptions import ClientError
from pr_agent.config_loader import get_settings
from pr_agent.log import get_logger
from pr_agent.secret_providers.secret_provider import SecretProvider
class AWSSecretsManagerProvider(SecretProvider):
def __init__(self):
try:
region_name = get_settings().get("aws_secrets_manager.region_name") or \
get_settings().get("aws.AWS_REGION_NAME")
if region_name:
self.client = boto3.client('secretsmanager', region_name=region_name)
else:
self.client = boto3.client('secretsmanager')
self.secret_arn = get_settings().get("aws_secrets_manager.secret_arn")
if not self.secret_arn:
raise ValueError("AWS Secrets Manager ARN is not configured")
except Exception as e:
get_logger().error(f"Failed to initialize AWS Secrets Manager Provider: {e}")
raise e
def get_secret(self, secret_name: str) -> str:
"""
Retrieve individual secret by name (for webhook tokens)
"""
try:
response = self.client.get_secret_value(SecretId=secret_name)
return response['SecretString']
except Exception as e:
get_logger().warning(f"Failed to get secret {secret_name} from AWS Secrets Manager: {e}")
return ""
def get_all_secrets(self) -> dict:
"""
Retrieve all secrets for configuration override
"""
try:
response = self.client.get_secret_value(SecretId=self.secret_arn)
return json.loads(response['SecretString'])
except Exception as e:
get_logger().error(f"Failed to get secrets from AWS Secrets Manager {self.secret_arn}: {e}")
return {}
def store_secret(self, secret_name: str, secret_value: str):
try:
self.client.put_secret_value(
SecretId=secret_name,
SecretString=secret_value
)
except Exception as e:
get_logger().error(f"Failed to store secret {secret_name} in AWS Secrets Manager: {e}")
raise e

View File

@ -0,0 +1,38 @@
{
"name": "Qodo Merge",
"description": "Qodo Merge",
"key": "app_key",
"vendor": {
"name": "Qodo",
"url": "https://qodo.ai"
},
"authentication": {
"type": "jwt"
},
"baseUrl": "base_url",
"lifecycle": {
"installed": "/installed",
"uninstalled": "/uninstalled"
},
"scopes": [
"account",
"repository:write",
"pullrequest:write",
"wiki"
],
"contexts": [
"account"
],
"modules": {
"webhooks": [
{
"event": "*",
"url": "/webhook"
}
]
},
"links": {
"privacy": "https://qodo.ai/privacy-policy",
"terms": "https://qodo.ai/terms"
}
}

View File

@ -30,5 +30,9 @@
"url": "/webhook"
}
]
},
"links": {
"privacy": "https://qodo.ai/privacy-policy",
"terms": "https://qodo.ai/terms"
}
}

View File

@ -0,0 +1,128 @@
import asyncio
import copy
import os
from typing import Any, Dict
from fastapi import APIRouter, FastAPI, HTTPException, Request, Response
from starlette.background import BackgroundTasks
from starlette.middleware import Middleware
from starlette_context import context
from starlette_context.middleware import RawContextMiddleware
from pr_agent.agent.pr_agent import PRAgent
from pr_agent.config_loader import get_settings, global_settings
from pr_agent.log import LoggingFormat, get_logger, setup_logger
from pr_agent.servers.utils import verify_signature
# Setup logging and router
setup_logger(fmt=LoggingFormat.JSON, level=get_settings().get("CONFIG.LOG_LEVEL", "DEBUG"))
router = APIRouter()
@router.post("/api/v1/gitea_webhooks")
async def handle_gitea_webhooks(background_tasks: BackgroundTasks, request: Request, response: Response):
"""Handle incoming Gitea webhook requests"""
get_logger().debug("Received a Gitea webhook")
body = await get_body(request)
# Set context for the request
context["settings"] = copy.deepcopy(global_settings)
context["git_provider"] = {}
# Handle the webhook in background
background_tasks.add_task(handle_request, body, event=request.headers.get("X-Gitea-Event", None))
return {}
async def get_body(request: Request):
"""Parse and verify webhook request body"""
try:
body = await request.json()
except Exception as e:
get_logger().error("Error parsing request body", artifact={'error': e})
raise HTTPException(status_code=400, detail="Error parsing request body") from e
# Verify webhook signature
webhook_secret = getattr(get_settings().gitea, 'webhook_secret', None)
if webhook_secret:
body_bytes = await request.body()
signature_header = request.headers.get('x-gitea-signature', None)
if not signature_header:
get_logger().error("Missing signature header")
raise HTTPException(status_code=400, detail="Missing signature header")
try:
verify_signature(body_bytes, webhook_secret, f"sha256={signature_header}")
except Exception as ex:
get_logger().error(f"Invalid signature: {ex}")
raise HTTPException(status_code=401, detail="Invalid signature")
return body
async def handle_request(body: Dict[str, Any], event: str):
"""Process Gitea webhook events"""
action = body.get("action")
if not action:
get_logger().debug("No action found in request body")
return {}
agent = PRAgent()
# Handle different event types
if event == "pull_request":
if action in ["opened", "reopened", "synchronized"]:
await handle_pr_event(body, event, action, agent)
elif event == "issue_comment":
if action == "created":
await handle_comment_event(body, event, action, agent)
return {}
async def handle_pr_event(body: Dict[str, Any], event: str, action: str, agent: PRAgent):
"""Handle pull request events"""
pr = body.get("pull_request", {})
if not pr:
return
api_url = pr.get("url")
if not api_url:
return
# Handle PR based on action
if action in ["opened", "reopened"]:
commands = get_settings().get("gitea.pr_commands", [])
for command in commands:
await agent.handle_request(api_url, command)
elif action == "synchronized":
# Handle push to PR
await agent.handle_request(api_url, "/review --incremental")
async def handle_comment_event(body: Dict[str, Any], event: str, action: str, agent: PRAgent):
"""Handle comment events"""
comment = body.get("comment", {})
if not comment:
return
comment_body = comment.get("body", "")
if not comment_body or not comment_body.startswith("/"):
return
pr_url = body.get("pull_request", {}).get("url")
if not pr_url:
return
await agent.handle_request(pr_url, comment_body)
# FastAPI app setup
middleware = [Middleware(RawContextMiddleware)]
app = FastAPI(middleware=middleware)
app.include_router(router)
def start():
"""Start the Gitea webhook server"""
port = int(os.environ.get("PORT", "3000"))
import uvicorn
uvicorn.run(app, host="0.0.0.0", port=port)
if __name__ == "__main__":
start()

View File

@ -80,6 +80,30 @@ async def run_action():
except Exception as e:
get_logger().info(f"github action: failed to apply repo settings: {e}")
# Append the response language in the extra instructions
try:
response_language = get_settings().config.get('response_language', 'en-us')
if response_language.lower() != 'en-us':
get_logger().info(f'User has set the response language to: {response_language}')
lang_instruction_text = f"Your response MUST be written in the language corresponding to locale code: '{response_language}'. This is crucial."
separator_text = "\n======\n\nIn addition, "
for key in get_settings():
setting = get_settings().get(key)
if str(type(setting)) == "<class 'dynaconf.utils.boxing.DynaBox'>":
if key.lower() in ['pr_description', 'pr_code_suggestions', 'pr_reviewer']:
if hasattr(setting, 'extra_instructions'):
extra_instructions = setting.extra_instructions
if lang_instruction_text not in str(extra_instructions):
updated_instructions = (
str(extra_instructions) + separator_text + lang_instruction_text
if extra_instructions else lang_instruction_text
)
setting.extra_instructions = updated_instructions
except Exception as e:
get_logger().info(f"github action: failed to apply language-specific instructions: {e}")
# Handle pull request opened event
if GITHUB_EVENT_NAME == "pull_request" or GITHUB_EVENT_NAME == "pull_request_target":
action = event_payload.get("action")
@ -102,7 +126,7 @@ async def run_action():
auto_improve = get_setting_or_env("GITHUB_ACTION_CONFIG.AUTO_IMPROVE", None)
# Set the configuration for auto actions
get_settings().config.is_auto_command = True # Set the flag to indicate that the command is auto
get_settings().config.is_auto_command = True # Set the flag to indicate that the command is auto
get_settings().pr_description.final_update_message = False # No final update message when auto_describe is enabled
get_logger().info(f"Running auto actions: auto_describe={auto_describe}, auto_review={auto_review}, auto_improve={auto_improve}")

View File

@ -0,0 +1,27 @@
from fastapi import FastAPI
from mangum import Mangum
from starlette.middleware import Middleware
from starlette_context.middleware import RawContextMiddleware
from pr_agent.servers.github_app import router
try:
from pr_agent.config_loader import apply_secrets_manager_config
apply_secrets_manager_config()
except Exception as e:
try:
from pr_agent.log import get_logger
get_logger().debug(f"AWS Secrets Manager initialization failed, falling back to environment variables: {e}")
except:
# Fail completely silently if log module is not available
pass
middleware = [Middleware(RawContextMiddleware)]
app = FastAPI(middleware=middleware)
app.include_router(router)
handler = Mangum(app, lifespan="off")
def lambda_handler(event, context):
return handler(event, context)

View File

@ -0,0 +1,27 @@
from fastapi import FastAPI
from mangum import Mangum
from starlette.middleware import Middleware
from starlette_context.middleware import RawContextMiddleware
from pr_agent.servers.gitlab_webhook import router
try:
from pr_agent.config_loader import apply_secrets_manager_config
apply_secrets_manager_config()
except Exception as e:
try:
from pr_agent.log import get_logger
get_logger().debug(f"AWS Secrets Manager initialization failed, falling back to environment variables: {e}")
except:
# Fail completely silently if log module is not available
pass
middleware = [Middleware(RawContextMiddleware)]
app = FastAPI(middleware=middleware)
app.include_router(router)
handler = Mangum(app, lifespan="off")
def lambda_handler(event, context):
return handler(event, context)

View File

@ -1,16 +0,0 @@
from fastapi import FastAPI
from mangum import Mangum
from starlette.middleware import Middleware
from starlette_context.middleware import RawContextMiddleware
from pr_agent.servers.github_app import router
middleware = [Middleware(RawContextMiddleware)]
app = FastAPI(middleware=middleware)
app.include_router(router)
handler = Mangum(app, lifespan="off")
def serverless(event, context):
return handler(event, context)

View File

@ -68,6 +68,11 @@ webhook_secret = "<WEBHOOK SECRET>" # Optional, may be commented out.
personal_access_token = ""
shared_secret = "" # webhook secret
[gitea]
# Gitea personal access token
personal_access_token=""
webhook_secret="" # webhook secret
[bitbucket]
# For Bitbucket authentication
auth_type = "bearer" # "bearer" or "basic"
@ -111,4 +116,13 @@ api_base = "" # Your Azure OpenAI service base URL (e.g., https://openai.xyz.co
[openrouter]
key = ""
api_base = ""
api_base = ""
[aws]
AWS_ACCESS_KEY_ID = ""
AWS_SECRET_ACCESS_KEY = ""
AWS_REGION_NAME = ""
[aws_secrets_manager]
secret_arn = "" # The ARN of the AWS Secrets Manager secret containing PR-Agent configuration
region_name = "" # Optional: specific AWS region (defaults to AWS_REGION_NAME or Lambda region)

View File

@ -39,7 +39,7 @@ allow_dynamic_context=true
max_extra_lines_before_dynamic_context = 10 # will try to include up to 10 extra lines before the hunk in the patch, until we reach an enclosing function or class
patch_extra_lines_before = 5 # 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
secret_provider=""
secret_provider="" # "" (disabled), "google_cloud_storage", or "aws_secrets_manager" for secure secret management
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
@ -56,6 +56,7 @@ ignore_pr_source_branches = [] # a list of regular expressions of source branche
ignore_pr_labels = [] # labels to ignore from PR agent when an PR is created
ignore_pr_authors = [] # authors to ignore from PR agent when an PR is created
ignore_repositories = [] # a list of regular expressions of repository full names (e.g. "org/repo") to ignore from PR agent processing
ignore_language_framework = [] # a list of code-generation languages or frameworks (e.g. 'protobuf', 'go_gen') whose auto-generated source files will be excluded from analysis
#
is_auto_command = false # will be auto-set to true if the command is triggered by an automation
enable_ai_metadata = false # will enable adding ai metadata
@ -64,6 +65,7 @@ reasoning_effort = "medium" # "low", "medium", "high"
enable_auto_approval=false # Set to true to enable auto-approval of PRs under certain conditions
auto_approve_for_low_review_effort=-1 # -1 to disable, [1-5] to set the threshold for auto-approval
auto_approve_for_no_suggestions=false # If true, the PR will be auto-approved if there are no suggestions
ensure_ticket_compliance=false # Set to true to disable auto-approval of PRs if the ticket is not compliant
# extended thinking for Claude reasoning models
enable_claude_extended_thinking = false # Set to true to enable extended thinking feature
extended_thinking_budget_tokens = 2048
@ -77,10 +79,13 @@ require_tests_review=true
require_estimate_effort_to_review=true
require_can_be_split_review=false
require_security_review=true
require_todo_scan=false
require_ticket_analysis_review=true
# general options
publish_output_no_suggestions=true # Set to "false" if you only need the reviewer's remarks (not labels, not "security audit", etc.) and want to avoid noisy "No major issues detected" comments.
persistent_comment=true
extra_instructions = ""
num_max_findings = 3
final_update_message = true
# review labels
enable_review_labels_security=true
@ -102,6 +107,7 @@ enable_pr_type=true
final_update_message = true
enable_help_text=false
enable_help_comment=true
enable_pr_diagram=true # adds a section with a diagram of the PR changes
# describe as comment
publish_description_as_comment=false
publish_description_as_comment_persistent=true
@ -278,6 +284,15 @@ push_commands = [
"/review",
]
[gitea_app]
url = "https://gitea.com"
handle_push_trigger = false
pr_commands = [
"/describe",
"/review",
"/improve",
]
[bitbucket_app]
pr_commands = [
"/describe --pr_description.final_update_message=false",

View File

@ -0,0 +1,42 @@
[generated_code]
# Protocol Buffers
protobuf = [
"**/*.pb.go",
"**/*.pb.cc",
"**/*_pb2.py",
"**/*.pb.swift",
"**/*.pb.rb",
"**/*.pb.php",
"**/*.pb.h"
]
# OpenAPI / Swagger stubs
openapi = [
"**/__generated__/**",
"**/openapi_client/**",
"**/openapi_server/**"
]
swagger = [
"**/swagger.json",
"**/swagger.yaml"
]
# GraphQL codegen
graphql = [
"**/*.graphql.ts",
"**/*.generated.ts",
"**/*.graphql.js"
]
# RPC / gRPC Generators
grpc_python = ["**/*_grpc.py"]
grpc_java = ["**/*Grpc.java"]
grpc_csharp = ["**/*Grpc.cs"]
grpc_typescript = ["**/*_grpc.ts", "**/*_grpc.js"]
# Go code generators
go_gen = [
"**/*_gen.go",
"**/*generated.go"
]

View File

@ -1,11 +1,12 @@
[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 - type, description, title and files walkthrough.
Your task is to provide a full description for the PR content: type, description, title, and files walkthrough.
- Focus on the new PR code (lines starting with '+' in the 'PR Git Diff' section).
- 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, names or file paths from the code, use backticks (`) instead of single quote (').
- When needed, use '- ' as bullets
{%- if extra_instructions %}
@ -46,6 +47,9 @@ class PRDescription(BaseModel):
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')")
description: str = Field(description="summarize the PR changes in up to four bullet points, each up to 8 words. For large PRs, add sub-bullets if needed. Order bullets by importance, with each bullet highlighting a key change group.")
title: str = Field(description="a concise and descriptive title that captures the PR's main theme")
{%- if enable_pr_diagram %}
changes_diagram: str = Field(description="a horizontal diagram that represents the main PR changes, in the format of a valid mermaid LR flowchart. The diagram should be concise and easy to read. Leave empty if no diagram is relevant. To create robust Mermaid diagrams, follow this two-step process: (1) Declare the nodes: nodeID["node description"]. (2) Then define the links: nodeID1 -- "link text" --> nodeID2. Node description must always be surrounded with quotation marks.")
{%- endif %}
{%- if enable_semantic_files_types %}
pr_files: List[FileDescription] = Field(max_items=20, description="a list of all the files that were changed in the PR, and summary of their changes. Each file must be analyzed regardless of change size.")
{%- endif %}
@ -62,6 +66,13 @@ description: |
...
title: |
...
{%- if enable_pr_diagram %}
changes_diagram: |
```mermaid
flowchart LR
...
```
{%- endif %}
{%- if enable_semantic_files_types %}
pr_files:
- filename: |
@ -143,6 +154,13 @@ description: |
...
title: |
...
{%- if enable_pr_diagram %}
changes_diagram: |
```mermaid
flowchart LR
...
```
{%- endif %}
{%- if enable_semantic_files_types %}
pr_files:
- filename: |

View File

@ -1,12 +1,12 @@
[pr_help_prompts]
system="""You are Doc-helper, a language models designed to answer questions about a documentation website for an open-soure project called "PR-Agent" (recently renamed to "Qodo Merge").
You will recieve a question, and the full documentation website content.
You will receive a question, and the full documentation website content.
Your goal is to provide the best answer to the question using the documentation provided.
Additional instructions:
- Try to be short and concise in your answers. Try to give examples if needed.
- The main tools of PR-Agent are 'describe', 'review', 'improve'. If there is ambiguity to which tool the user is referring to, prioritize snippets of these tools over others.
- If the question has ambiguity and can relate to different tools or platfroms, provide the best answer possible based on what is available, but also state in your answer what additional information would be needed to give a more accurate answer.
- If the question has ambiguity and can relate to different tools or platforms, provide the best answer possible based on what is available, but also state in your answer what additional information would be needed to give a more accurate answer.
The output must be a YAML object equivalent to type $DocHelper, according to the following Pydantic definitions:

View File

@ -2,7 +2,7 @@
system="""You are PR-Reviewer, a language model designed to review a Git Pull Request (PR).
Given the PR Info and the PR Git Diff, generate 3 short questions about the PR code for the PR author.
The goal of the questions is to help the language model understand the PR better, so the questions should be insightful, informative, non-trivial, and relevant to the PR.
You should prefer asking yes\\no questions, or multiple choice questions. Also add at least one open-ended question, but make sure they are not too difficult, and can be answered in a sentence or two.
You should prefer asking yes/no questions, or multiple choice questions. Also add at least one open-ended question, but make sure they are not too difficult, and can be answered in a sentence or two.
Example output:

View File

@ -37,9 +37,9 @@ __new hunk__
======
- In the format above, the diff is organized into separate '__new hunk__' and '__old hunk__' sections for each code chunk. '__new hunk__' contains the updated code, while '__old hunk__' shows the removed code. If no code was removed in a specific chunk, the __old hunk__ section will be omitted.
- We also added line numbers for the '__new hunk__' code, to help you refer to the code lines in your suggestions. These line numbers are not part of the actual code, and should only used for reference.
- We also added line numbers for the '__new hunk__' code, to help you refer to the code lines in your suggestions. These line numbers are not part of the actual code, and should only be used for reference.
- Code lines are prefixed with symbols ('+', '-', ' '). The '+' symbol indicates new code added in the PR, the '-' symbol indicates code removed in the PR, and the ' ' symbol indicates unchanged code. \
The review should address new code added in the PR code diff (lines starting with '+')
The review should address new code added in the PR code diff (lines starting with '+').
{%- if is_ai_metadata %}
- If available, an AI-generated summary will appear and provide a high-level overview of the file changes. Note that this summary may not be fully accurate or complete.
{%- endif %}
@ -72,6 +72,13 @@ class KeyIssuesComponentLink(BaseModel):
start_line: int = Field(description="The start line that corresponds to this issue in the relevant file")
end_line: int = Field(description="The end line that corresponds to this issue in the relevant file")
{%- if require_todo_scan %}
class TodoSection(BaseModel):
relevant_file: str = Field(description="The full path of the file containing the TODO comment")
line_number: int = Field(description="The line number where the TODO comment starts")
content: str = Field(description="The content of the TODO comment. Only include actual TODO comments within code comments (e.g., comments starting with '#', '//', '/*', '<!--', ...). Remove leading 'TODO' prefixes. If more than 10 words, summarize the TODO comment to a single short sentence up to 10 words.")
{%- endif %}
{%- if related_tickets %}
class TicketCompliance(BaseModel):
@ -93,14 +100,17 @@ class Review(BaseModel):
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.")
{%- endif %}
{%- if require_tests %}
relevant_tests: str = Field(description="yes\\no question: does this PR have relevant tests added or updated ?")
relevant_tests: str = Field(description="yes/no question: does this PR have relevant tests added or updated ?")
{%- endif %}
{%- if question_str %}
insights_from_user_answers: str = Field(description="shortly summarize the insights you gained from the user's answers to the questions")
{%- endif %}
key_issues_to_review: List[KeyIssuesComponentLink] = Field("A short and diverse list (0-3 issues) of high-priority bugs, problems or performance concerns introduced in the PR code, which the PR reviewer should further focus on and validate during the review process.")
key_issues_to_review: List[KeyIssuesComponentLink] = Field("A short and diverse list (0-{{ num_max_findings }} issues) of high-priority bugs, problems or performance concerns introduced in the PR code, which the PR reviewer should further focus on and validate during the review process.")
{%- if require_security_review %}
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' (without explaining why) 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")
security_concerns: str = Field(description="Does this PR code introduce 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' (without explaining why) 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")
{%- endif %}
{%- if require_todo_scan %}
todo_sections: Union[List[TodoSection], str] = Field(description="A list of TODO comments found in the PR code. Return 'No' (as a string) if there are no TODO comments in the PR")
{%- endif %}
{%- if require_can_be_split_review %}
can_be_split: List[SubPR] = Field(min_items=0, max_items=3, description="Can this PR, which contains {{ num_pr_files }} changed files in total, be divided into smaller sub-PRs with distinct tasks that can be reviewed and merged independently, regardless of the order ? Make sure that the sub-PRs are indeed independent, with no code dependencies between them, and that each sub-PR represent a meaningful independent task. Output an empty list if the PR code does not need to be split.")
@ -148,6 +158,10 @@ review:
- ...
security_concerns: |
No
{%- if require_todo_scan %}
todo_sections: |
No
{%- endif %}
{%- if require_can_be_split_review %}
can_be_split:
- relevant_files:
@ -182,6 +196,13 @@ Ticket Description:
{{ ticket.body }}
#####
{%- endif %}
{%- if ticket.requirements %}
Ticket Requirements:
#####
{{ ticket.requirements }}
#####
{%- endif %}
=====
{% endfor %}
{%- endif %}
@ -266,6 +287,10 @@ review:
- ...
security_concerns: |
No
{%- if require_todo_scan %}
todo_sections: |
No
{%- endif %}
{%- if require_can_be_split_review %}
can_be_split:
- relevant_files:

View File

@ -614,11 +614,13 @@ class PRCodeSuggestions:
break
if original_initial_line:
suggested_initial_line = new_code_snippet.splitlines()[0]
original_initial_spaces = len(original_initial_line) - len(original_initial_line.lstrip())
original_initial_spaces = len(original_initial_line) - len(original_initial_line.lstrip()) # lstrip works both for spaces and tabs
suggested_initial_spaces = len(suggested_initial_line) - len(suggested_initial_line.lstrip())
delta_spaces = original_initial_spaces - suggested_initial_spaces
if delta_spaces > 0:
new_code_snippet = textwrap.indent(new_code_snippet, delta_spaces * " ").rstrip('\n')
# Detect indentation character from original line
indent_char = '\t' if original_initial_line.startswith('\t') else ' '
new_code_snippet = textwrap.indent(new_code_snippet, delta_spaces * indent_char).rstrip('\n')
except Exception as e:
get_logger().error(f"Error when dedenting code snippet for file {relevant_file}, error: {e}")

View File

@ -59,6 +59,7 @@ class PRDescription:
# Initialize the variables dictionary
self.COLLAPSIBLE_FILE_LIST_THRESHOLD = get_settings().pr_description.get("collapsible_file_list_threshold", 8)
enable_pr_diagram = get_settings().pr_description.get("enable_pr_diagram", False) and self.git_provider.is_supported("gfm_markdown") # github and gitlab support gfm_markdown
self.vars = {
"title": self.git_provider.pr.title,
"branch": self.git_provider.get_pr_branch(),
@ -72,7 +73,8 @@ class PRDescription:
"enable_semantic_files_types": get_settings().pr_description.enable_semantic_files_types,
"related_tickets": "",
"include_file_summary_changes": len(self.git_provider.get_diff_files()) <= self.COLLAPSIBLE_FILE_LIST_THRESHOLD,
'duplicate_prompt_examples': get_settings().config.get('duplicate_prompt_examples', False),
"duplicate_prompt_examples": get_settings().config.get("duplicate_prompt_examples", False),
"enable_pr_diagram": enable_pr_diagram,
}
self.user_description = self.git_provider.get_user_description()
@ -199,7 +201,7 @@ class PRDescription:
async def _prepare_prediction(self, model: str) -> None:
if get_settings().pr_description.use_description_markers and 'pr_agent:' not in self.user_description:
get_logger().info("Markers were enabled, but user description does not contain markers. skipping AI prediction")
get_logger().info("Markers were enabled, but user description does not contain markers. Skipping AI prediction")
return None
large_pr_handling = get_settings().pr_description.enable_large_pr_handling and "pr_description_only_files_prompts" in get_settings()
@ -456,6 +458,12 @@ class PRDescription:
self.data['labels'] = self.data.pop('labels')
if 'description' in self.data:
self.data['description'] = self.data.pop('description')
if 'changes_diagram' in self.data:
changes_diagram = self.data.pop('changes_diagram').strip()
if changes_diagram.startswith('```'):
if not changes_diagram.endswith('```'): # fallback for missing closing
changes_diagram += '\n```'
self.data['changes_diagram'] = '\n'+ changes_diagram
if 'pr_files' in self.data:
self.data['pr_files'] = self.data.pop('pr_files')
@ -707,7 +715,7 @@ class PRDescription:
pr_body += """</tr></tbody></table>"""
except Exception as e:
get_logger().error(f"Error processing pr files to markdown {self.pr_id}: {str(e)}")
get_logger().error(f"Error processing PR files to markdown {self.pr_id}: {str(e)}")
pass
return pr_body, pr_comments
@ -820,4 +828,4 @@ def replace_code_tags(text):
parts = text.split('`')
for i in range(1, len(parts), 2):
parts[i] = '<code>' + parts[i] + '</code>'
return ''.join(parts)
return ''.join(parts)

View File

@ -21,7 +21,7 @@ from pr_agent.servers.help import HelpMessage
#Common code that can be called from similar tools:
def modify_answer_section(ai_response: str) -> str | None:
# Gets the model's answer and relevant sources section, repacing the heading of the answer section with:
# Gets the model's answer and relevant sources section, replacing the heading of the answer section with:
# :bulb: Auto-generated documentation-based answer:
"""
For example: The following input:

View File

@ -81,11 +81,13 @@ class PRReviewer:
"language": self.main_language,
"diff": "", # empty diff for initial calculation
"num_pr_files": self.git_provider.get_num_of_files(),
"num_max_findings": get_settings().pr_reviewer.num_max_findings,
"require_score": get_settings().pr_reviewer.require_score_review,
"require_tests": get_settings().pr_reviewer.require_tests_review,
"require_estimate_effort_to_review": get_settings().pr_reviewer.require_estimate_effort_to_review,
'require_can_be_split_review': get_settings().pr_reviewer.require_can_be_split_review,
'require_security_review': get_settings().pr_reviewer.require_security_review,
'require_todo_scan': get_settings().pr_reviewer.get("require_todo_scan", False),
'question_str': question_str,
'answer_str': answer_str,
"extra_instructions": get_settings().pr_reviewer.extra_instructions,
@ -157,25 +159,32 @@ class PRReviewer:
pr_review = self._prepare_pr_review()
get_logger().debug(f"PR output", artifact=pr_review)
if get_settings().config.publish_output:
# publish the review
if get_settings().pr_reviewer.persistent_comment and not self.incremental.is_incremental:
final_update_message = get_settings().pr_reviewer.final_update_message
self.git_provider.publish_persistent_comment(pr_review,
initial_header=f"{PRReviewHeader.REGULAR.value} 🔍",
update_header=True,
final_update_message=final_update_message, )
else:
self.git_provider.publish_comment(pr_review)
self.git_provider.remove_initial_comment()
else:
get_logger().info("Review output is not published")
should_publish = get_settings().config.publish_output and self._should_publish_review_no_suggestions(pr_review)
if not should_publish:
reason = "Review output is not published"
if get_settings().config.publish_output:
reason += ": no major issues detected."
get_logger().info(reason)
get_settings().data = {"artifact": pr_review}
return
# publish the review
if get_settings().pr_reviewer.persistent_comment and not self.incremental.is_incremental:
final_update_message = get_settings().pr_reviewer.final_update_message
self.git_provider.publish_persistent_comment(pr_review,
initial_header=f"{PRReviewHeader.REGULAR.value} 🔍",
update_header=True,
final_update_message=final_update_message, )
else:
self.git_provider.publish_comment(pr_review)
self.git_provider.remove_initial_comment()
except Exception as e:
get_logger().error(f"Failed to review PR: {e}")
def _should_publish_review_no_suggestions(self, pr_review: str) -> bool:
return get_settings().pr_reviewer.get('publish_output_no_suggestions', True) or "No major issues detected" not in pr_review
async def _prepare_prediction(self, model: str) -> None:
self.patches_diff = get_pr_diff(self.git_provider,
self.token_handler,
@ -316,7 +325,9 @@ class PRReviewer:
get_logger().exception(f"Failed to remove previous review comment, error: {e}")
def _can_run_incremental_review(self) -> bool:
"""Checks if we can run incremental review according the various configurations and previous review"""
"""
Checks if we can run incremental review according the various configurations and previous review.
"""
# checking if running is auto mode but there are no new commits
if self.is_auto and not self.incremental.first_new_commit_sha:
get_logger().info(f"Incremental review is enabled for {self.pr_url} but there are no new commits")

View File

@ -58,7 +58,7 @@ class PRUpdateChangelog:
'config': dict(get_settings().config)}
get_logger().debug("Relevant configs", artifacts=relevant_configs)
# currently only GitHub is supported for pushing changelog changes
# check if the git provider supports pushing changelog changes
if get_settings().pr_update_changelog.push_changelog_changes and not hasattr(
self.git_provider, "create_or_update_pr_file"
):
@ -128,6 +128,7 @@ class PRUpdateChangelog:
existing_content = self.changelog_file
else:
existing_content = ""
if existing_content:
new_file_content = answer + "\n\n" + self.changelog_file
else:
@ -186,12 +187,18 @@ Example:
self.changelog_file = self.git_provider.get_pr_file_content(
"CHANGELOG.md", self.git_provider.get_pr_branch()
)
if isinstance(self.changelog_file, bytes):
self.changelog_file = self.changelog_file.decode('utf-8')
changelog_file_lines = self.changelog_file.splitlines()
changelog_file_lines = changelog_file_lines[:CHANGELOG_LINES]
self.changelog_file_str = "\n".join(changelog_file_lines)
except Exception:
except Exception as e:
get_logger().warning(f"Error getting changelog file: {e}")
self.changelog_file_str = ""
self.changelog_file = ""
return
if not self.changelog_file_str:
self.changelog_file_str = self._get_default_changelog()

View File

@ -3,6 +3,7 @@ import traceback
from pr_agent.config_loader import get_settings
from pr_agent.git_providers import GithubProvider
from pr_agent.git_providers import AzureDevopsProvider
from pr_agent.log import get_logger
# Compile the regex pattern once, outside the function
@ -131,6 +132,32 @@ async def extract_tickets(git_provider):
return tickets_content
elif isinstance(git_provider, AzureDevopsProvider):
tickets_info = git_provider.get_linked_work_items()
tickets_content = []
for ticket in tickets_info:
try:
ticket_body_str = ticket.get("body", "")
if len(ticket_body_str) > MAX_TICKET_CHARACTERS:
ticket_body_str = ticket_body_str[:MAX_TICKET_CHARACTERS] + "..."
tickets_content.append(
{
"ticket_id": ticket.get("id"),
"ticket_url": ticket.get("url"),
"title": ticket.get("title"),
"body": ticket_body_str,
"requirements": ticket.get("acceptance_criteria", ""),
"labels": ", ".join(ticket.get("labels", [])),
}
)
except Exception as e:
get_logger().error(
f"Error processing Azure DevOps ticket: {e}",
artifact={"traceback": traceback.format_exc()},
)
return tickets_content
except Exception as e:
get_logger().error(f"Error extracting tickets error= {e}",
artifact={"traceback": traceback.format_exc()})

View File

@ -1,10 +1,10 @@
[build-system]
requires = ["setuptools>=61.0"]
requires = ["setuptools>=61.0", "wheel"]
build-backend = "setuptools.build_meta"
[project]
name = "pr-agent"
version = "0.2.7"
version = "0.3.0"
authors = [{ name = "QodoAI", email = "tal.r@qodo.ai" }]
@ -16,7 +16,7 @@ description = "QodoAI PR-Agent aims to help efficiently review and handle pull r
readme = "README.md"
requires-python = ">=3.12"
keywords = ["AI", "Agents", "Pull Request", "Automation", "Code Review"]
license = "Apache-2.0"
license = { file = "LICENSE" }
classifiers = [
"Intended Audience :: Developers",
@ -34,7 +34,6 @@ dependencies = { file = ["requirements.txt"] }
[tool.setuptools]
include-package-data = true
license-files = ["LICENSE"]
[tool.setuptools.packages.find]
where = ["."]

View File

@ -1,5 +1,5 @@
aiohttp==3.9.5
anthropic>=0.48
anthropic>=0.52.0
#anthropic[vertex]==0.47.1
atlassian-python-api==3.41.4
azure-devops==7.1.0b3
@ -13,7 +13,7 @@ google-cloud-aiplatform==1.38.0
google-generativeai==0.8.3
google-cloud-storage==2.10.0
Jinja2==3.1.2
litellm==1.69.3
litellm==1.70.4
loguru==0.7.2
msrest==0.7.1
openai>=1.55.3
@ -31,6 +31,7 @@ gunicorn==22.0.0
pytest-cov==5.0.0
pydantic==2.8.2
html2text==2024.2.26
giteapy==1.0.8
# Uncomment the following lines to enable the 'similar issue' tool
# pinecone-client
# pinecone-datasets @ git+https://github.com/mrT23/pinecone-datasets.git@main

View File

@ -0,0 +1,90 @@
import asyncio
import os
import time
from pr_agent.algo.ai_handlers.langchain_ai_handler import LangChainOpenAIHandler
from pr_agent.config_loader import get_settings
def check_settings():
print('Checking settings...')
settings = get_settings()
# Check OpenAI settings
if not hasattr(settings, 'openai'):
print('OpenAI settings not found')
return False
if not hasattr(settings.openai, 'key'):
print('OpenAI API key not found')
return False
print('OpenAI API key found')
return True
async def measure_performance(handler, num_requests=3):
print(f'\nRunning performance test with {num_requests} requests...')
start_time = time.time()
# Create multiple requests
tasks = [
handler.chat_completion(
model='gpt-3.5-turbo',
system='You are a helpful assistant',
user=f'Test message {i}',
temperature=0.2
) for i in range(num_requests)
]
# Execute requests concurrently
responses = await asyncio.gather(*tasks)
end_time = time.time()
total_time = end_time - start_time
avg_time = total_time / num_requests
print(f'Performance results:')
print(f'Total time: {total_time:.2f} seconds')
print(f'Average time per request: {avg_time:.2f} seconds')
print(f'Requests per second: {num_requests/total_time:.2f}')
return responses
async def test():
print('Starting test...')
# Check settings first
if not check_settings():
print('Please set up your environment variables or configuration file')
print('Required: OPENAI_API_KEY')
return
try:
handler = LangChainOpenAIHandler()
print('Handler created')
# Basic functionality test
response = await handler.chat_completion(
model='gpt-3.5-turbo',
system='You are a helpful assistant',
user='Hello',
temperature=0.2,
img_path='test.jpg'
)
print('Response:', response)
# Performance test
await measure_performance(handler)
except Exception as e:
print('Error:', str(e))
print('Error type:', type(e))
print('Error details:', e.__dict__ if hasattr(e, '__dict__') else 'No additional details')
if __name__ == '__main__':
print('Environment variables:')
print('OPENAI_API_KEY:', 'Set' if os.getenv('OPENAI_API_KEY') else 'Not set')
print('OPENAI_API_TYPE:', os.getenv('OPENAI_API_TYPE', 'Not set'))
print('OPENAI_API_BASE:', os.getenv('OPENAI_API_BASE', 'Not set'))
asyncio.run(test())

View File

@ -0,0 +1,185 @@
import os
import time
import requests
from datetime import datetime
from pr_agent.config_loader import get_settings
from pr_agent.log import get_logger, setup_logger
from tests.e2e_tests.e2e_utils import (FILE_PATH,
IMPROVE_START_WITH_REGEX_PATTERN,
NEW_FILE_CONTENT, NUM_MINUTES,
PR_HEADER_START_WITH, REVIEW_START_WITH)
log_level = os.environ.get("LOG_LEVEL", "INFO")
setup_logger(log_level)
logger = get_logger()
def test_e2e_run_gitea_app():
repo_name = 'pr-agent-tests'
owner = 'codiumai'
base_branch = "main"
new_branch = f"gitea_app_e2e_test-{datetime.now().strftime('%Y-%m-%d-%H-%M-%S')}"
get_settings().config.git_provider = "gitea"
headers = None
pr_number = None
try:
gitea_url = get_settings().get("GITEA.URL", None)
gitea_token = get_settings().get("GITEA.TOKEN", None)
if not gitea_url:
logger.error("GITEA.URL is not set in the configuration")
logger.info("Please set GITEA.URL in .env file or environment variables")
assert False, "GITEA.URL is not set in the configuration"
if not gitea_token:
logger.error("GITEA.TOKEN is not set in the configuration")
logger.info("Please set GITEA.TOKEN in .env file or environment variables")
assert False, "GITEA.TOKEN is not set in the configuration"
headers = {
'Authorization': f'token {gitea_token}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
logger.info(f"Creating a new branch {new_branch} from {base_branch}")
response = requests.get(
f"{gitea_url}/api/v1/repos/{owner}/{repo_name}/branches/{base_branch}",
headers=headers
)
response.raise_for_status()
base_branch_data = response.json()
base_commit_sha = base_branch_data['commit']['id']
branch_data = {
'ref': f"refs/heads/{new_branch}",
'sha': base_commit_sha
}
response = requests.post(
f"{gitea_url}/api/v1/repos/{owner}/{repo_name}/git/refs",
headers=headers,
json=branch_data
)
response.raise_for_status()
logger.info(f"Updating file {FILE_PATH} in branch {new_branch}")
import base64
file_content_encoded = base64.b64encode(NEW_FILE_CONTENT.encode()).decode()
try:
response = requests.get(
f"{gitea_url}/api/v1/repos/{owner}/{repo_name}/contents/{FILE_PATH}?ref={new_branch}",
headers=headers
)
response.raise_for_status()
existing_file = response.json()
file_sha = existing_file.get('sha')
file_data = {
'message': 'Update cli_pip.py',
'content': file_content_encoded,
'sha': file_sha,
'branch': new_branch
}
except:
file_data = {
'message': 'Add cli_pip.py',
'content': file_content_encoded,
'branch': new_branch
}
response = requests.put(
f"{gitea_url}/api/v1/repos/{owner}/{repo_name}/contents/{FILE_PATH}",
headers=headers,
json=file_data
)
response.raise_for_status()
logger.info(f"Creating a pull request from {new_branch} to {base_branch}")
pr_data = {
'title': f'Test PR from {new_branch}',
'body': 'update cli_pip.py',
'head': new_branch,
'base': base_branch
}
response = requests.post(
f"{gitea_url}/api/v1/repos/{owner}/{repo_name}/pulls",
headers=headers,
json=pr_data
)
response.raise_for_status()
pr = response.json()
pr_number = pr['number']
for i in range(NUM_MINUTES):
logger.info(f"Waiting for the PR to get all the tool results...")
time.sleep(60)
response = requests.get(
f"{gitea_url}/api/v1/repos/{owner}/{repo_name}/issues/{pr_number}/comments",
headers=headers
)
response.raise_for_status()
comments = response.json()
if len(comments) >= 5:
valid_review = False
for comment in comments:
if comment['body'].startswith('## PR Reviewer Guide 🔍'):
valid_review = True
break
if valid_review:
break
else:
logger.error("REVIEW feedback is invalid")
raise Exception("REVIEW feedback is invalid")
else:
logger.info(f"Waiting for the PR to get all the tool results. {i + 1} minute(s) passed")
else:
assert False, f"After {NUM_MINUTES} minutes, the PR did not get all the tool results"
logger.info(f"Cleaning up: closing PR and deleting branch {new_branch}")
close_data = {'state': 'closed'}
response = requests.patch(
f"{gitea_url}/api/v1/repos/{owner}/{repo_name}/pulls/{pr_number}",
headers=headers,
json=close_data
)
response.raise_for_status()
response = requests.delete(
f"{gitea_url}/api/v1/repos/{owner}/{repo_name}/git/refs/heads/{new_branch}",
headers=headers
)
response.raise_for_status()
logger.info(f"Succeeded in running e2e test for Gitea app on the PR")
except Exception as e:
logger.error(f"Failed to run e2e test for Gitea app: {e}")
raise
finally:
try:
if headers is None or gitea_url is None:
return
if pr_number is not None:
requests.patch(
f"{gitea_url}/api/v1/repos/{owner}/{repo_name}/pulls/{pr_number}",
headers=headers,
json={'state': 'closed'}
)
requests.delete(
f"{gitea_url}/api/v1/repos/{owner}/{repo_name}/git/refs/heads/{new_branch}",
headers=headers
)
except Exception as cleanup_error:
logger.error(f"Failed to clean up after test: {cleanup_error}")
if __name__ == '__main__':
test_e2e_run_gitea_app()

View File

@ -0,0 +1,92 @@
import pytest
from pr_agent.servers.github_app import handle_new_pr_opened
from pr_agent.tools.pr_add_docs import PRAddDocs
from pr_agent.agent.pr_agent import PRAgent
from pr_agent.config_loader import get_settings
from pr_agent.identity_providers.identity_provider import Eligibility
from pr_agent.identity_providers import get_identity_provider
@pytest.mark.asyncio
@pytest.mark.parametrize(
"action,draft,state,should_run",
[
("opened", False, "open", True),
("edited", False, "open", False),
("opened", True, "open", False),
("opened", False, "closed", False),
],
)
async def test_add_docs_trigger(monkeypatch, action, draft, state, should_run):
# Mock settings to enable the "/add_docs" auto-command on PR opened
settings = get_settings()
settings.github_app.pr_commands = ["/add_docs"]
settings.github_app.handle_pr_actions = ["opened"]
# Define a FakeGitProvider for both apply_repo_settings and PRAddDocs
class FakeGitProvider:
def __init__(self, pr_url, *args, **kwargs):
self.pr = type("pr", (), {"title": "Test PR"})()
self.get_pr_branch = lambda: "test-branch"
self.get_pr_description = lambda: "desc"
self.get_languages = lambda: ["Python"]
self.get_files = lambda: []
self.get_commit_messages = lambda: "msg"
self.publish_comment = lambda *args, **kwargs: None
self.remove_initial_comment = lambda: None
self.publish_code_suggestions = lambda suggestions: True
self.diff_files = []
self.get_repo_settings = lambda: {}
# Patch Git provider lookups
monkeypatch.setattr(
"pr_agent.git_providers.utils.get_git_provider_with_context",
lambda pr_url: FakeGitProvider(pr_url),
)
monkeypatch.setattr(
"pr_agent.tools.pr_add_docs.get_git_provider",
lambda: FakeGitProvider,
)
# Ensure identity provider always eligible
monkeypatch.setattr(
get_identity_provider().__class__,
"verify_eligibility",
lambda *args, **kwargs: Eligibility.ELIGIBLE,
)
# Spy on PRAddDocs.run()
ran = {"flag": False}
async def fake_run(self):
ran["flag"] = True
monkeypatch.setattr(PRAddDocs, "run", fake_run)
# Build minimal PR payload
body = {
"action": action,
"pull_request": {
"url": "https://example.com/fake/pr",
"state": state,
"draft": draft,
},
}
log_context = {}
# Invoke the PR-open handler
agent = PRAgent()
await handle_new_pr_opened(
body=body,
event="pull_request",
sender="tester",
sender_id="123",
action=action,
log_context=log_context,
agent=agent,
)
assert ran["flag"] is should_run, (
f"Expected run() to be {'called' if should_run else 'skipped'}"
f" for action={action!r}, draft={draft}, state={state!r}"
)

View File

@ -0,0 +1,89 @@
import json
import pytest
from unittest.mock import MagicMock, patch
from botocore.exceptions import ClientError
from pr_agent.secret_providers.aws_secrets_manager_provider import AWSSecretsManagerProvider
class TestAWSSecretsManagerProvider:
def _provider(self):
"""Create provider following existing pattern"""
with patch('pr_agent.secret_providers.aws_secrets_manager_provider.get_settings') as mock_get_settings, \
patch('pr_agent.secret_providers.aws_secrets_manager_provider.boto3.client') as mock_boto3_client:
settings = MagicMock()
settings.get.side_effect = lambda k, d=None: {
'aws_secrets_manager.secret_arn': 'arn:aws:secretsmanager:us-east-1:123456789012:secret:test-secret',
'aws_secrets_manager.region_name': 'us-east-1',
'aws.AWS_REGION_NAME': 'us-east-1'
}.get(k, d)
settings.aws_secrets_manager.secret_arn = 'arn:aws:secretsmanager:us-east-1:123456789012:secret:test-secret'
mock_get_settings.return_value = settings
# Mock boto3 client
mock_client = MagicMock()
mock_boto3_client.return_value = mock_client
provider = AWSSecretsManagerProvider()
provider.client = mock_client # Set client directly for testing
return provider, mock_client
# Positive test cases
def test_get_secret_success(self):
provider, mock_client = self._provider()
mock_client.get_secret_value.return_value = {'SecretString': 'test-secret-value'}
result = provider.get_secret('test-secret-name')
assert result == 'test-secret-value'
mock_client.get_secret_value.assert_called_once_with(SecretId='test-secret-name')
def test_get_all_secrets_success(self):
provider, mock_client = self._provider()
secret_data = {'openai.key': 'sk-test', 'github.webhook_secret': 'webhook-secret'}
mock_client.get_secret_value.return_value = {'SecretString': json.dumps(secret_data)}
result = provider.get_all_secrets()
assert result == secret_data
# Negative test cases (following Google Cloud Storage pattern)
def test_get_secret_failure(self):
provider, mock_client = self._provider()
mock_client.get_secret_value.side_effect = Exception("AWS error")
result = provider.get_secret('nonexistent-secret')
assert result == "" # Confirm empty string is returned
def test_get_all_secrets_failure(self):
provider, mock_client = self._provider()
mock_client.get_secret_value.side_effect = Exception("AWS error")
result = provider.get_all_secrets()
assert result == {} # Confirm empty dictionary is returned
def test_store_secret_update_existing(self):
provider, mock_client = self._provider()
mock_client.update_secret.return_value = {}
provider.store_secret('test-secret', 'test-value')
mock_client.put_secret_value.assert_called_once_with(
SecretId='test-secret',
SecretString='test-value'
)
def test_init_failure_invalid_config(self):
with patch('pr_agent.secret_providers.aws_secrets_manager_provider.get_settings') as mock_get_settings:
settings = MagicMock()
settings.aws_secrets_manager.secret_arn = None # Configuration error
mock_get_settings.return_value = settings
with pytest.raises(Exception):
AWSSecretsManagerProvider()
def test_store_secret_failure(self):
provider, mock_client = self._provider()
mock_client.put_secret_value.side_effect = Exception("AWS error")
with pytest.raises(Exception):
provider.store_secret('test-secret', 'test-value')

View File

@ -1,13 +1,302 @@
# Generated by CodiumAI
import pytest
from unittest.mock import patch, MagicMock
from pr_agent.algo.utils import clip_tokens
from pr_agent.algo.token_handler import TokenEncoder
class TestClipTokens:
def test_clip(self):
"""Comprehensive test suite for the clip_tokens function."""
def test_empty_input_text(self):
"""Test that empty input returns empty string."""
assert clip_tokens("", 10) == ""
assert clip_tokens(None, 10) is None
def test_text_under_token_limit(self):
"""Test that text under the token limit is returned unchanged."""
text = "Short text"
max_tokens = 100
result = clip_tokens(text, max_tokens)
assert result == text
def test_text_exactly_at_token_limit(self):
"""Test text that is exactly at the token limit."""
text = "This is exactly at the limit"
# Mock the token encoder to return exact limit
with patch.object(TokenEncoder, 'get_token_encoder') as mock_encoder:
mock_tokenizer = MagicMock()
mock_tokenizer.encode.return_value = [1] * 10 # Exactly 10 tokens
mock_encoder.return_value = mock_tokenizer
result = clip_tokens(text, 10)
assert result == text
def test_text_over_token_limit_with_three_dots(self):
"""Test text over token limit with three dots addition."""
text = "This is a longer text that should be clipped when it exceeds the token limit"
max_tokens = 5
with patch.object(TokenEncoder, 'get_token_encoder') as mock_encoder:
mock_tokenizer = MagicMock()
mock_tokenizer.encode.return_value = [1] * 20 # 20 tokens
mock_encoder.return_value = mock_tokenizer
result = clip_tokens(text, max_tokens)
assert result.endswith("\n...(truncated)")
assert len(result) < len(text)
def test_text_over_token_limit_without_three_dots(self):
"""Test text over token limit without three dots addition."""
text = "This is a longer text that should be clipped"
max_tokens = 5
with patch.object(TokenEncoder, 'get_token_encoder') as mock_encoder:
mock_tokenizer = MagicMock()
mock_tokenizer.encode.return_value = [1] * 20 # 20 tokens
mock_encoder.return_value = mock_tokenizer
result = clip_tokens(text, max_tokens, add_three_dots=False)
assert not result.endswith("\n...(truncated)")
assert len(result) < len(text)
def test_negative_max_tokens(self):
"""Test that negative max_tokens returns empty string."""
text = "Some text"
result = clip_tokens(text, -1)
assert result == ""
result = clip_tokens(text, -100)
assert result == ""
def test_zero_max_tokens(self):
"""Test that zero max_tokens returns empty string."""
text = "Some text"
result = clip_tokens(text, 0)
assert result == ""
def test_delete_last_line_functionality(self):
"""Test the delete_last_line parameter functionality."""
text = "Line 1\nLine 2\nLine 3\nLine 4"
max_tokens = 5
with patch.object(TokenEncoder, 'get_token_encoder') as mock_encoder:
mock_tokenizer = MagicMock()
mock_tokenizer.encode.return_value = [1] * 20 # 20 tokens
mock_encoder.return_value = mock_tokenizer
# Without delete_last_line
result_normal = clip_tokens(text, max_tokens, delete_last_line=False)
# With delete_last_line
result_deleted = clip_tokens(text, max_tokens, delete_last_line=True)
# The result with delete_last_line should be shorter or equal
assert len(result_deleted) <= len(result_normal)
def test_pre_computed_num_input_tokens(self):
"""Test using pre-computed num_input_tokens parameter."""
text = "This is a test text"
max_tokens = 10
num_input_tokens = 15
# Should not call the encoder when num_input_tokens is provided
with patch.object(TokenEncoder, 'get_token_encoder') as mock_encoder:
mock_encoder.return_value = None # Should not be called
result = clip_tokens(text, max_tokens, num_input_tokens=num_input_tokens)
assert result.endswith("\n...(truncated)")
mock_encoder.assert_not_called()
def test_pre_computed_tokens_under_limit(self):
"""Test pre-computed tokens under the limit."""
text = "Short text"
max_tokens = 20
num_input_tokens = 5
with patch.object(TokenEncoder, 'get_token_encoder') as mock_encoder:
mock_encoder.return_value = None # Should not be called
result = clip_tokens(text, max_tokens, num_input_tokens=num_input_tokens)
assert result == text
mock_encoder.assert_not_called()
def test_special_characters_and_unicode(self):
"""Test text with special characters and Unicode content."""
text = "Special chars: @#$%^&*()_+ áéíóú 中문 🚀 emoji"
max_tokens = 5
with patch.object(TokenEncoder, 'get_token_encoder') as mock_encoder:
mock_tokenizer = MagicMock()
mock_tokenizer.encode.return_value = [1] * 20 # 20 tokens
mock_encoder.return_value = mock_tokenizer
result = clip_tokens(text, max_tokens)
assert isinstance(result, str)
assert len(result) < len(text)
def test_multiline_text_handling(self):
"""Test handling of multiline text."""
text = "Line 1\nLine 2\nLine 3\nLine 4\nLine 5"
max_tokens = 5
with patch.object(TokenEncoder, 'get_token_encoder') as mock_encoder:
mock_tokenizer = MagicMock()
mock_tokenizer.encode.return_value = [1] * 20 # 20 tokens
mock_encoder.return_value = mock_tokenizer
result = clip_tokens(text, max_tokens)
assert isinstance(result, str)
def test_very_long_text(self):
"""Test with very long text."""
text = "A" * 10000 # Very long text
max_tokens = 10
with patch.object(TokenEncoder, 'get_token_encoder') as mock_encoder:
mock_tokenizer = MagicMock()
mock_tokenizer.encode.return_value = [1] * 5000 # Many tokens
mock_encoder.return_value = mock_tokenizer
result = clip_tokens(text, max_tokens)
assert len(result) < len(text)
assert result.endswith("\n...(truncated)")
def test_encoder_exception_handling(self):
"""Test handling of encoder exceptions."""
text = "Test text"
max_tokens = 10
with patch.object(TokenEncoder, 'get_token_encoder') as mock_encoder:
mock_encoder.side_effect = Exception("Encoder error")
# Should return original text when encoder fails
result = clip_tokens(text, max_tokens)
assert result == text
def test_zero_division_scenario(self):
"""Test scenario that could lead to division by zero."""
text = "Test"
max_tokens = 10
with patch.object(TokenEncoder, 'get_token_encoder') as mock_encoder:
mock_tokenizer = MagicMock()
mock_tokenizer.encode.return_value = [] # Empty tokens (could cause division by zero)
mock_encoder.return_value = mock_tokenizer
result = clip_tokens(text, max_tokens)
# Should handle gracefully and return original text
assert result == text
def test_various_edge_cases(self):
"""Test various edge cases."""
# Single character
assert clip_tokens("A", 1000) == "A"
# Only whitespace
text = " \n \t "
with patch.object(TokenEncoder, 'get_token_encoder') as mock_encoder:
mock_tokenizer = MagicMock()
mock_tokenizer.encode.return_value = [1] * 10
mock_encoder.return_value = mock_tokenizer
result = clip_tokens(text, 5)
assert isinstance(result, str)
# Text with only newlines
text = "\n\n\n\n"
with patch.object(TokenEncoder, 'get_token_encoder') as mock_encoder:
mock_tokenizer = MagicMock()
mock_tokenizer.encode.return_value = [1] * 10
mock_encoder.return_value = mock_tokenizer
result = clip_tokens(text, 2, delete_last_line=True)
assert isinstance(result, str)
def test_parameter_combinations(self):
"""Test different parameter combinations."""
text = "Multi\nline\ntext\nfor\ntesting"
max_tokens = 5
with patch.object(TokenEncoder, 'get_token_encoder') as mock_encoder:
mock_tokenizer = MagicMock()
mock_tokenizer.encode.return_value = [1] * 20
mock_encoder.return_value = mock_tokenizer
# Test all combinations
combinations = [
(True, True), # add_three_dots=True, delete_last_line=True
(True, False), # add_three_dots=True, delete_last_line=False
(False, True), # add_three_dots=False, delete_last_line=True
(False, False), # add_three_dots=False, delete_last_line=False
]
for add_dots, delete_line in combinations:
result = clip_tokens(text, max_tokens,
add_three_dots=add_dots,
delete_last_line=delete_line)
assert isinstance(result, str)
if add_dots and len(result) > 0:
assert result.endswith("\n...(truncated)") or result == text
def test_num_output_chars_zero_scenario(self):
"""Test scenario where num_output_chars becomes zero or negative."""
text = "Short"
max_tokens = 1
with patch.object(TokenEncoder, 'get_token_encoder') as mock_encoder:
mock_tokenizer = MagicMock()
mock_tokenizer.encode.return_value = [1] * 1000 # Many tokens for short text
mock_encoder.return_value = mock_tokenizer
result = clip_tokens(text, max_tokens)
# When num_output_chars is 0 or negative, should return empty string
assert result == ""
def test_logging_on_exception(self):
"""Test that exceptions are properly logged."""
text = "Test text"
max_tokens = 10
# Patch the logger at the module level where it's imported
with patch('pr_agent.algo.utils.get_logger') as mock_logger:
mock_log_instance = MagicMock()
mock_logger.return_value = mock_log_instance
with patch.object(TokenEncoder, 'get_token_encoder') as mock_encoder:
mock_encoder.side_effect = Exception("Test exception")
result = clip_tokens(text, max_tokens)
# Should log the warning
mock_log_instance.warning.assert_called_once()
# Should return original text
assert result == text
def test_factor_safety_calculation(self):
"""Test that the 0.9 factor (10% reduction) works correctly."""
text = "Test text that should be reduced by 10 percent for safety"
max_tokens = 10
with patch.object(TokenEncoder, 'get_token_encoder') as mock_encoder:
mock_tokenizer = MagicMock()
mock_tokenizer.encode.return_value = [1] * 20 # 20 tokens
mock_encoder.return_value = mock_tokenizer
result = clip_tokens(text, max_tokens)
# The result should be shorter due to the 0.9 factor
# Characters per token = len(text) / 20
# Expected chars = int(0.9 * (len(text) / 20) * 10)
expected_chars = int(0.9 * (len(text) / 20) * 10)
# Result should be around expected_chars length (plus truncation text)
if result.endswith("\n...(truncated)"):
actual_content = result[:-len("\n...(truncated)")]
assert len(actual_content) <= expected_chars + 5 # Some tolerance
# Test the original basic functionality to ensure backward compatibility
def test_clip_original_functionality(self):
"""Test original functionality from the existing test."""
text = "line1\nline2\nline3\nline4\nline5\nline6"
max_tokens = 25
result = clip_tokens(text, max_tokens)
@ -16,4 +305,4 @@ class TestClipTokens:
max_tokens = 10
result = clip_tokens(text, max_tokens)
expected_results = 'line1\nline2\nline3\n\n...(truncated)'
assert result == expected_results
assert result == expected_results

View File

@ -0,0 +1,120 @@
import pytest
from unittest.mock import MagicMock, patch
from pr_agent.config_loader import apply_secrets_manager_config, apply_secrets_to_config
class TestConfigLoaderSecrets:
def test_apply_secrets_manager_config_success(self):
with patch('pr_agent.secret_providers.get_secret_provider') as mock_get_provider, \
patch('pr_agent.config_loader.apply_secrets_to_config') as mock_apply_secrets, \
patch('pr_agent.config_loader.get_settings') as mock_get_settings:
# Mock secret provider
mock_provider = MagicMock()
mock_provider.get_all_secrets.return_value = {'openai.key': 'sk-test'}
mock_get_provider.return_value = mock_provider
# Mock settings
settings = MagicMock()
settings.get.return_value = "aws_secrets_manager"
mock_get_settings.return_value = settings
apply_secrets_manager_config()
mock_apply_secrets.assert_called_once_with({'openai.key': 'sk-test'})
def test_apply_secrets_manager_config_no_provider(self):
with patch('pr_agent.secret_providers.get_secret_provider') as mock_get_provider:
mock_get_provider.return_value = None
# Confirm no exception is raised
apply_secrets_manager_config()
def test_apply_secrets_manager_config_not_aws(self):
with patch('pr_agent.secret_providers.get_secret_provider') as mock_get_provider, \
patch('pr_agent.config_loader.get_settings') as mock_get_settings:
# Mock Google Cloud Storage provider
mock_provider = MagicMock()
mock_get_provider.return_value = mock_provider
# Mock settings (Google Cloud Storage)
settings = MagicMock()
settings.get.return_value = "google_cloud_storage"
mock_get_settings.return_value = settings
# Confirm execution is skipped for non-AWS Secrets Manager
apply_secrets_manager_config()
# Confirm get_all_secrets is not called
assert not hasattr(mock_provider, 'get_all_secrets') or \
not mock_provider.get_all_secrets.called
def test_apply_secrets_to_config_nested_keys(self):
with patch('pr_agent.config_loader.get_settings') as mock_get_settings:
settings = MagicMock()
settings.get.return_value = None # No existing value
settings.set = MagicMock()
mock_get_settings.return_value = settings
secrets = {
'openai.key': 'sk-test',
'github.webhook_secret': 'webhook-secret'
}
apply_secrets_to_config(secrets)
# Confirm settings are applied correctly
settings.set.assert_any_call('OPENAI.KEY', 'sk-test')
settings.set.assert_any_call('GITHUB.WEBHOOK_SECRET', 'webhook-secret')
def test_apply_secrets_to_config_existing_value_preserved(self):
with patch('pr_agent.config_loader.get_settings') as mock_get_settings:
settings = MagicMock()
settings.get.return_value = "existing-value" # Existing value present
settings.set = MagicMock()
mock_get_settings.return_value = settings
secrets = {'openai.key': 'sk-test'}
apply_secrets_to_config(secrets)
# Confirm settings are not overridden when existing value present
settings.set.assert_not_called()
def test_apply_secrets_to_config_single_key(self):
with patch('pr_agent.config_loader.get_settings') as mock_get_settings:
settings = MagicMock()
settings.get.return_value = None
settings.set = MagicMock()
mock_get_settings.return_value = settings
secrets = {'simple_key': 'simple_value'}
apply_secrets_to_config(secrets)
# Confirm non-dot notation keys are ignored
settings.set.assert_not_called()
def test_apply_secrets_to_config_multiple_dots(self):
with patch('pr_agent.config_loader.get_settings') as mock_get_settings:
settings = MagicMock()
settings.get.return_value = None
settings.set = MagicMock()
mock_get_settings.return_value = settings
secrets = {'section.subsection.key': 'value'}
apply_secrets_to_config(secrets)
# Confirm keys with multiple dots are ignored
settings.set.assert_not_called()
def test_apply_secrets_manager_config_exception_handling(self):
with patch('pr_agent.secret_providers.get_secret_provider') as mock_get_provider:
mock_get_provider.side_effect = Exception("Provider error")
# Confirm processing continues even when exception occurs
apply_secrets_manager_config() # Confirm no exception is raised

View File

@ -1,4 +1,7 @@
# Generated by CodiumAI
import textwrap
from unittest.mock import Mock
from pr_agent.algo.utils import PRReviewHeader, convert_to_markdown_v2
from pr_agent.tools.pr_description import insert_br_after_x_chars
@ -48,9 +51,174 @@ class TestConvertToMarkdown:
input_data = {'review': {
'estimated_effort_to_review_[1-5]': '1, because the changes are minimal and straightforward, focusing on a single functionality addition.\n',
'relevant_tests': 'No\n', 'possible_issues': 'No\n', 'security_concerns': 'No\n'}}
expected_output = textwrap.dedent(f"""\
{PRReviewHeader.REGULAR.value} 🔍
Here are some key observations to aid the review process:
<table>
<tr><td>⏱️&nbsp;<strong>Estimated effort to review</strong>: 1 🔵⚪⚪⚪⚪</td></tr>
<tr><td>🧪&nbsp;<strong>No relevant tests</strong></td></tr>
<tr><td>&nbsp;<strong>Possible issues</strong>: No
</td></tr>
<tr><td>🔒&nbsp;<strong>No security concerns identified</strong></td></tr>
</table>
""")
assert convert_to_markdown_v2(input_data).strip() == expected_output.strip()
def test_simple_dictionary_input_without_gfm_supported(self):
input_data = {'review': {
'estimated_effort_to_review_[1-5]': '1, because the changes are minimal and straightforward, focusing on a single functionality addition.\n',
'relevant_tests': 'No\n', 'possible_issues': 'No\n', 'security_concerns': 'No\n'}}
expected_output = textwrap.dedent("""\
## PR Reviewer Guide 🔍
Here are some key observations to aid the review process:
### ⏱️ Estimated effort to review: 1 🔵⚪⚪⚪⚪
### 🧪 No relevant tests
### Possible issues: No
expected_output = f'{PRReviewHeader.REGULAR.value} 🔍\n\nHere are some key observations to aid the review process:\n\n<table>\n<tr><td>⏱️&nbsp;<strong>Estimated effort to review</strong>: 1 🔵⚪⚪⚪⚪</td></tr>\n<tr><td>🧪&nbsp;<strong>No relevant tests</strong></td></tr>\n<tr><td>&nbsp;<strong>Possible issues</strong>: No\n</td></tr>\n<tr><td>🔒&nbsp;<strong>No security concerns identified</strong></td></tr>\n</table>'
### 🔒 No security concerns identified
""")
assert convert_to_markdown_v2(input_data, gfm_supported=False).strip() == expected_output.strip()
def test_key_issues_to_review(self):
input_data = {'review': {
'key_issues_to_review': [
{
'relevant_file' : 'src/utils.py',
'issue_header' : 'Code Smell',
'issue_content' : 'The function is too long and complex.',
'start_line': 30,
'end_line': 50,
}
]
}}
mock_git_provider = Mock()
reference_link = 'https://github.com/qodo/pr-agent/pull/1/files#diff-hashvalue-R174'
mock_git_provider.get_line_link.return_value = reference_link
expected_output = textwrap.dedent(f"""\
## PR Reviewer Guide 🔍
Here are some key observations to aid the review process:
<table>
<tr><td>⚡&nbsp;<strong>Recommended focus areas for review</strong><br><br>
<a href='{reference_link}'><strong>Code Smell</strong></a><br>The function is too long and complex.
</td></tr>
</table>
""")
assert convert_to_markdown_v2(input_data, git_provider=mock_git_provider).strip() == expected_output.strip()
mock_git_provider.get_line_link.assert_called_with('src/utils.py', 30, 50)
def test_ticket_compliance(self):
input_data = {'review': {
'ticket_compliance_check': [
{
'ticket_url': 'https://example.com/ticket/123',
'ticket_requirements': '- Requirement 1\n- Requirement 2\n',
'fully_compliant_requirements': '- Requirement 1\n- Requirement 2\n',
'not_compliant_requirements': '',
'requires_further_human_verification': '',
}
]
}}
expected_output = textwrap.dedent("""\
## PR Reviewer Guide 🔍
Here are some key observations to aid the review process:
<table>
<tr><td>
**🎫 Ticket compliance analysis ✅**
**[123](https://example.com/ticket/123) - Fully compliant**
Compliant requirements:
- Requirement 1
- Requirement 2
</td></tr>
</table>
""")
assert convert_to_markdown_v2(input_data).strip() == expected_output.strip()
def test_can_be_split(self):
input_data = {'review': {
'can_be_split': [
{
'relevant_files': [
'src/file1.py',
'src/file2.py'
],
'title': 'Refactoring',
},
{
'relevant_files': [
'src/file3.py'
],
'title': 'Bug Fix',
}
]
}
}
expected_output = textwrap.dedent("""\
## PR Reviewer Guide 🔍
Here are some key observations to aid the review process:
<table>
<tr><td>🔀 <strong>Multiple PR themes</strong><br><br>
<details><summary>
Sub-PR theme: <b>Refactoring</b></summary>
___
Relevant files:
- src/file1.py
- src/file2.py
___
</details>
<details><summary>
Sub-PR theme: <b>Bug Fix</b></summary>
___
Relevant files:
- src/file3.py
___
</details>
</td></tr>
</table>
""")
assert convert_to_markdown_v2(input_data).strip() == expected_output.strip()

View File

@ -80,3 +80,53 @@ class TestIgnoreFilter:
filtered_files = filter_ignored(files)
assert filtered_files == expected, f"Expected {[file.filename for file in expected]}, but got {[file.filename for file in filtered_files]}."
def test_language_framework_ignores(self, monkeypatch):
"""
Test files are ignored based on language/framework mapping (e.g., protobuf).
"""
monkeypatch.setattr(global_settings.config, 'ignore_language_framework', ['protobuf', 'go_gen'])
files = [
type('', (object,), {'filename': 'main.go'})(),
type('', (object,), {'filename': 'dir1/service.pb.go'})(),
type('', (object,), {'filename': 'dir1/dir/data_pb2.py'})(),
type('', (object,), {'filename': 'file.py'})(),
type('', (object,), {'filename': 'dir2/file_gen.go'})(),
type('', (object,), {'filename': 'file.generated.go'})()
]
expected = [
files[0],
files[3]
]
filtered = filter_ignored(files)
assert filtered == expected, (
f"Expected {[f.filename for f in expected]}, "
f"but got {[f.filename for f in filtered]}"
)
def test_skip_invalid_ignore_language_framework(self, monkeypatch):
"""
Test skipping of generated code filtering when ignore_language_framework is not a list
"""
monkeypatch.setattr(global_settings.config, 'ignore_language_framework', 'protobuf')
files = [
type('', (object,), {'filename': 'main.go'})(),
type('', (object,), {'filename': 'file.py'})(),
type('', (object,), {'filename': 'dir1/service.pb.go'})(),
type('', (object,), {'filename': 'file_pb2.py'})()
]
expected = [
files[0],
files[1],
files[2],
files[3]
]
filtered = filter_ignored(files)
assert filtered == expected, (
f"Expected {[f.filename for f in expected]}, "
f"but got {[f.filename for f in filtered]}"
)

View File

@ -0,0 +1,21 @@
from pr_agent.algo.utils import fix_json_escape_char
class TestFixJsonEscapeChar:
def test_valid_json(self):
"""Return unchanged when input JSON is already valid"""
text = '{"a": 1, "b": "ok"}'
expected_output = {"a": 1, "b": "ok"}
assert fix_json_escape_char(text) == expected_output
def test_single_control_char(self):
"""Remove a single ASCII control-character"""
text = '{"msg": "hel\x01lo"}'
expected_output = {"msg": "hel lo"}
assert fix_json_escape_char(text) == expected_output
def test_multiple_control_chars(self):
"""Remove multiple control-characters recursively"""
text = '{"x": "A\x02B\x03C"}'
expected_output = {"x": "A B C"}
assert fix_json_escape_char(text) == expected_output

View File

@ -0,0 +1,67 @@
import pytest
from pr_agent.algo.utils import get_max_tokens, MAX_TOKENS
import pr_agent.algo.utils as utils
class TestGetMaxTokens:
# Test if the file is in MAX_TOKENS
def test_model_max_tokens(self, monkeypatch):
fake_settings = type('', (), {
'config': type('', (), {
'custom_model_max_tokens': 0,
'max_model_tokens': 0
})()
})()
monkeypatch.setattr(utils, "get_settings", lambda: fake_settings)
model = "gpt-3.5-turbo"
expected = MAX_TOKENS[model]
assert get_max_tokens(model) == expected
# Test situations where the model is not registered and exists as a custom model
def test_model_has_custom(self, monkeypatch):
fake_settings = type('', (), {
'config': type('', (), {
'custom_model_max_tokens': 5000,
'max_model_tokens': 0 # 제한 없음
})()
})()
monkeypatch.setattr(utils, "get_settings", lambda: fake_settings)
model = "custom-model"
expected = 5000
assert get_max_tokens(model) == expected
def test_model_not_max_tokens_and_not_has_custom(self, monkeypatch):
fake_settings = type('', (), {
'config': type('', (), {
'custom_model_max_tokens': 0,
'max_model_tokens': 0
})()
})()
monkeypatch.setattr(utils, "get_settings", lambda: fake_settings)
model = "custom-model"
with pytest.raises(Exception):
get_max_tokens(model)
def test_model_max_tokens_with__limit(self, monkeypatch):
fake_settings = type('', (), {
'config': type('', (), {
'custom_model_max_tokens': 0,
'max_model_tokens': 10000
})()
})()
monkeypatch.setattr(utils, "get_settings", lambda: fake_settings)
model = "gpt-3.5-turbo" # this model setting is 160000
expected = 10000
assert get_max_tokens(model) == expected

View File

@ -0,0 +1,126 @@
# from unittest.mock import MagicMock, patch
#
# import pytest
#
# from pr_agent.algo.types import EDIT_TYPE
# from pr_agent.git_providers.gitea_provider import GiteaProvider
#
#
# class TestGiteaProvider:
# """Unit-tests for GiteaProvider following project style (explicit object construction, minimal patching)."""
#
# def _provider(self):
# """Create provider instance with patched settings and avoid real HTTP calls."""
# with patch('pr_agent.git_providers.gitea_provider.get_settings') as mock_get_settings, \
# patch('requests.get') as mock_get:
# settings = MagicMock()
# settings.get.side_effect = lambda k, d=None: {
# 'GITEA.URL': 'https://gitea.example.com',
# 'GITEA.PERSONAL_ACCESS_TOKEN': 'test-token'
# }.get(k, d)
# mock_get_settings.return_value = settings
# # Stub the PR fetch triggered during provider initialization
# pr_resp = MagicMock()
# pr_resp.json.return_value = {
# 'title': 'stub',
# 'body': 'stub',
# 'head': {'ref': 'main'},
# 'user': {'id': 1}
# }
# pr_resp.raise_for_status = MagicMock()
# mock_get.return_value = pr_resp
# return GiteaProvider('https://gitea.example.com/owner/repo/pulls/123')
#
# # ---------------- URL parsing ----------------
# def test_parse_pr_url_valid(self):
# owner, repo, pr_num = self._provider()._parse_pr_url('https://gitea.example.com/owner/repo/pulls/123')
# assert (owner, repo, pr_num) == ('owner', 'repo', '123')
#
# def test_parse_pr_url_invalid(self):
# with pytest.raises(ValueError):
# GiteaProvider._parse_pr_url('https://gitea.example.com/owner/repo')
#
# # ---------------- simple getters ----------------
# def test_get_files(self):
# provider = self._provider()
# mock_resp = MagicMock()
# mock_resp.json.return_value = [{'filename': 'a.txt'}, {'filename': 'b.txt'}]
# mock_resp.raise_for_status = MagicMock()
# with patch('requests.get', return_value=mock_resp) as mock_get:
# assert provider.get_files() == ['a.txt', 'b.txt']
# mock_get.assert_called_once()
#
# def test_get_diff_files(self):
# provider = self._provider()
# mock_resp = MagicMock()
# mock_resp.json.return_value = [
# {'filename': 'f1', 'previous_filename': 'old_f1', 'status': 'renamed', 'patch': ''},
# {'filename': 'f2', 'status': 'added', 'patch': ''},
# {'filename': 'f3', 'status': 'deleted', 'patch': ''},
# {'filename': 'f4', 'status': 'modified', 'patch': ''}
# ]
# mock_resp.raise_for_status = MagicMock()
# with patch('requests.get', return_value=mock_resp):
# res = provider.get_diff_files()
# assert [f.edit_type for f in res] == [EDIT_TYPE.RENAMED, EDIT_TYPE.ADDED, EDIT_TYPE.DELETED,
# EDIT_TYPE.MODIFIED]
#
# # ---------------- publishing methods ----------------
# def test_publish_description(self):
# provider = self._provider()
# mock_resp = MagicMock();
# mock_resp.raise_for_status = MagicMock()
# with patch('requests.patch', return_value=mock_resp) as mock_patch:
# provider.publish_description('t', 'b');
# mock_patch.assert_called_once()
#
# def test_publish_comment(self):
# provider = self._provider()
# mock_resp = MagicMock();
# mock_resp.raise_for_status = MagicMock()
# with patch('requests.post', return_value=mock_resp) as mock_post:
# provider.publish_comment('c');
# mock_post.assert_called_once()
#
# def test_publish_inline_comment(self):
# provider = self._provider()
# mock_resp = MagicMock();
# mock_resp.raise_for_status = MagicMock()
# with patch('requests.post', return_value=mock_resp) as mock_post:
# provider.publish_inline_comment('body', 'file', '10');
# mock_post.assert_called_once()
#
# # ---------------- labels & reactions ----------------
# def test_get_pr_labels(self):
# provider = self._provider()
# mock_resp = MagicMock();
# mock_resp.raise_for_status = MagicMock();
# mock_resp.json.return_value = [{'name': 'l1'}]
# with patch('requests.get', return_value=mock_resp):
# assert provider.get_pr_labels() == ['l1']
#
# def test_add_eyes_reaction(self):
# provider = self._provider()
# mock_resp = MagicMock();
# mock_resp.raise_for_status = MagicMock();
# mock_resp.json.return_value = {'id': 7}
# with patch('requests.post', return_value=mock_resp):
# assert provider.add_eyes_reaction(1) == 7
#
# # ---------------- commit messages & url helpers ----------------
# def test_get_commit_messages(self):
# provider = self._provider()
# mock_resp = MagicMock();
# mock_resp.raise_for_status = MagicMock()
# mock_resp.json.return_value = [
# {'commit': {'message': 'm1'}}, {'commit': {'message': 'm2'}}]
# with patch('requests.get', return_value=mock_resp):
# assert provider.get_commit_messages() == ['m1', 'm2']
#
# def test_git_url_helpers(self):
# provider = self._provider()
# issues_url = 'https://gitea.example.com/owner/repo/pulls/3'
# assert provider.get_git_repo_url(issues_url) == 'https://gitea.example.com/owner/repo.git'
# prefix, suffix = provider.get_canonical_url_parts('https://gitea.example.com/owner/repo.git', 'dev')
# assert prefix == 'https://gitea.example.com/owner/repo/src/branch/dev'
# assert suffix == ''

View File

@ -0,0 +1,147 @@
import pytest
from unittest.mock import MagicMock, patch
from pr_agent.git_providers.gitlab_provider import GitLabProvider
from gitlab import Gitlab
from gitlab.v4.objects import Project, ProjectFile
from gitlab.exceptions import GitlabGetError
class TestGitLabProvider:
"""Test suite for GitLab provider functionality."""
@pytest.fixture
def mock_gitlab_client(self):
client = MagicMock()
return client
@pytest.fixture
def mock_project(self):
project = MagicMock()
return project
@pytest.fixture
def gitlab_provider(self, mock_gitlab_client, mock_project):
with patch('pr_agent.git_providers.gitlab_provider.gitlab.Gitlab', return_value=mock_gitlab_client), \
patch('pr_agent.git_providers.gitlab_provider.get_settings') as mock_settings:
mock_settings.return_value.get.side_effect = lambda key, default=None: {
"GITLAB.URL": "https://gitlab.com",
"GITLAB.PERSONAL_ACCESS_TOKEN": "fake_token"
}.get(key, default)
mock_gitlab_client.projects.get.return_value = mock_project
provider = GitLabProvider("https://gitlab.com/test/repo/-/merge_requests/1")
provider.gl = mock_gitlab_client
provider.id_project = "test/repo"
return provider
def test_get_pr_file_content_success(self, gitlab_provider, mock_project):
mock_file = MagicMock(ProjectFile)
mock_file.decode.return_value = "# Changelog\n\n## v1.0.0\n- Initial release"
mock_project.files.get.return_value = mock_file
content = gitlab_provider.get_pr_file_content("CHANGELOG.md", "main")
assert content == "# Changelog\n\n## v1.0.0\n- Initial release"
mock_project.files.get.assert_called_once_with("CHANGELOG.md", "main")
mock_file.decode.assert_called_once()
def test_get_pr_file_content_with_bytes(self, gitlab_provider, mock_project):
mock_file = MagicMock(ProjectFile)
mock_file.decode.return_value = b"# Changelog\n\n## v1.0.0\n- Initial release"
mock_project.files.get.return_value = mock_file
content = gitlab_provider.get_pr_file_content("CHANGELOG.md", "main")
assert content == "# Changelog\n\n## v1.0.0\n- Initial release"
mock_project.files.get.assert_called_once_with("CHANGELOG.md", "main")
def test_get_pr_file_content_file_not_found(self, gitlab_provider, mock_project):
mock_project.files.get.side_effect = GitlabGetError("404 Not Found")
content = gitlab_provider.get_pr_file_content("CHANGELOG.md", "main")
assert content == ""
mock_project.files.get.assert_called_once_with("CHANGELOG.md", "main")
def test_get_pr_file_content_other_exception(self, gitlab_provider, mock_project):
mock_project.files.get.side_effect = Exception("Network error")
content = gitlab_provider.get_pr_file_content("CHANGELOG.md", "main")
assert content == ""
def test_create_or_update_pr_file_create_new(self, gitlab_provider, mock_project):
mock_project.files.get.side_effect = GitlabGetError("404 Not Found")
mock_file = MagicMock()
mock_project.files.create.return_value = mock_file
new_content = "# Changelog\n\n## v1.1.0\n- New feature"
commit_message = "Add CHANGELOG.md"
gitlab_provider.create_or_update_pr_file(
"CHANGELOG.md", "feature-branch", new_content, commit_message
)
mock_project.files.get.assert_called_once_with("CHANGELOG.md", "feature-branch")
mock_project.files.create.assert_called_once_with({
'file_path': 'CHANGELOG.md',
'branch': 'feature-branch',
'content': new_content,
'commit_message': commit_message,
})
def test_create_or_update_pr_file_update_existing(self, gitlab_provider, mock_project):
mock_file = MagicMock(ProjectFile)
mock_file.decode.return_value = "# Old changelog content"
mock_project.files.get.return_value = mock_file
new_content = "# New changelog content"
commit_message = "Update CHANGELOG.md"
gitlab_provider.create_or_update_pr_file(
"CHANGELOG.md", "feature-branch", new_content, commit_message
)
mock_project.files.get.assert_called_once_with("CHANGELOG.md", "feature-branch")
mock_file.content = new_content
mock_file.save.assert_called_once_with(branch="feature-branch", commit_message=commit_message)
def test_create_or_update_pr_file_update_exception(self, gitlab_provider, mock_project):
mock_project.files.get.side_effect = Exception("Network error")
with pytest.raises(Exception):
gitlab_provider.create_or_update_pr_file(
"CHANGELOG.md", "feature-branch", "content", "message"
)
def test_has_create_or_update_pr_file_method(self, gitlab_provider):
assert hasattr(gitlab_provider, "create_or_update_pr_file")
assert callable(getattr(gitlab_provider, "create_or_update_pr_file"))
def test_method_signature_compatibility(self, gitlab_provider):
import inspect
sig = inspect.signature(gitlab_provider.create_or_update_pr_file)
params = list(sig.parameters.keys())
expected_params = ['file_path', 'branch', 'contents', 'message']
assert params == expected_params
@pytest.mark.parametrize("content,expected", [
("simple text", "simple text"),
(b"bytes content", "bytes content"),
("", ""),
(b"", ""),
("unicode: café", "unicode: café"),
(b"unicode: caf\xc3\xa9", "unicode: café"),
])
def test_content_encoding_handling(self, gitlab_provider, mock_project, content, expected):
mock_file = MagicMock(ProjectFile)
mock_file.decode.return_value = content
mock_project.files.get.return_value = mock_file
result = gitlab_provider.get_pr_file_content("test.md", "main")
assert result == expected

View File

@ -79,13 +79,14 @@ class TestSortFilesByMainLanguages:
files = [
type('', (object,), {'filename': 'file1.py'})(),
type('', (object,), {'filename': 'file2.java'})(),
type('', (object,), {'filename': 'file3.cpp'})()
type('', (object,), {'filename': 'file3.cpp'})(),
type('', (object,), {'filename': 'file3.test'})()
]
expected_output = [
{'language': 'Python', 'files': [files[0]]},
{'language': 'Java', 'files': [files[1]]},
{'language': 'C++', 'files': [files[2]]},
{'language': 'Other', 'files': []}
{'language': 'Other', 'files': [files[3]]}
]
assert sort_files_by_main_languages(languages, files) == expected_output

View File

@ -0,0 +1,247 @@
import pytest
from unittest.mock import MagicMock, patch, AsyncMock
from pr_agent.tools.pr_update_changelog import PRUpdateChangelog
class TestPRUpdateChangelog:
"""Test suite for the PR Update Changelog functionality."""
@pytest.fixture
def mock_git_provider(self):
"""Create a mock git provider."""
provider = MagicMock()
provider.get_pr_branch.return_value = "feature-branch"
provider.get_pr_file_content.return_value = ""
provider.pr.title = "Test PR"
provider.get_pr_description.return_value = "Test description"
provider.get_commit_messages.return_value = "fix: test commit"
provider.get_languages.return_value = {"Python": 80, "JavaScript": 20}
provider.get_files.return_value = ["test.py", "test.js"]
return provider
@pytest.fixture
def mock_ai_handler(self):
"""Create a mock AI handler."""
handler = MagicMock()
handler.chat_completion = AsyncMock(return_value=("Test changelog entry", "stop"))
return handler
@pytest.fixture
def changelog_tool(self, mock_git_provider, mock_ai_handler):
"""Create a PRUpdateChangelog instance with mocked dependencies."""
with patch('pr_agent.tools.pr_update_changelog.get_git_provider', return_value=lambda url: mock_git_provider), \
patch('pr_agent.tools.pr_update_changelog.get_main_pr_language', return_value="Python"), \
patch('pr_agent.tools.pr_update_changelog.get_settings') as mock_settings:
# Configure mock settings
mock_settings.return_value.pr_update_changelog.push_changelog_changes = False
mock_settings.return_value.pr_update_changelog.extra_instructions = ""
mock_settings.return_value.pr_update_changelog_prompt.system = "System prompt"
mock_settings.return_value.pr_update_changelog_prompt.user = "User prompt"
mock_settings.return_value.config.temperature = 0.2
tool = PRUpdateChangelog("https://gitlab.com/test/repo/-/merge_requests/1", ai_handler=lambda: mock_ai_handler)
return tool
def test_get_changelog_file_with_existing_content(self, changelog_tool, mock_git_provider):
"""Test retrieving existing changelog content."""
# Arrange
existing_content = "# Changelog\n\n## v1.0.0\n- Initial release\n- Bug fixes"
mock_git_provider.get_pr_file_content.return_value = existing_content
# Act
changelog_tool._get_changelog_file()
# Assert
assert changelog_tool.changelog_file == existing_content
assert "# Changelog" in changelog_tool.changelog_file_str
def test_get_changelog_file_with_no_existing_content(self, changelog_tool, mock_git_provider):
"""Test handling when no changelog file exists."""
# Arrange
mock_git_provider.get_pr_file_content.return_value = ""
# Act
changelog_tool._get_changelog_file()
# Assert
assert changelog_tool.changelog_file == ""
assert "Example:" in changelog_tool.changelog_file_str # Default template
def test_get_changelog_file_with_bytes_content(self, changelog_tool, mock_git_provider):
"""Test handling when git provider returns bytes instead of string."""
# Arrange
content_bytes = b"# Changelog\n\n## v1.0.0\n- Initial release"
mock_git_provider.get_pr_file_content.return_value = content_bytes
# Act
changelog_tool._get_changelog_file()
# Assert
assert isinstance(changelog_tool.changelog_file, str)
assert changelog_tool.changelog_file == "# Changelog\n\n## v1.0.0\n- Initial release"
def test_get_changelog_file_with_exception(self, changelog_tool, mock_git_provider):
"""Test handling exceptions during file retrieval."""
# Arrange
mock_git_provider.get_pr_file_content.side_effect = Exception("Network error")
# Act
changelog_tool._get_changelog_file()
# Assert
assert changelog_tool.changelog_file == ""
assert changelog_tool.changelog_file_str == "" # Exception should result in empty string, no default template
def test_prepare_changelog_update_with_existing_content(self, changelog_tool):
"""Test preparing changelog update when existing content exists."""
# Arrange
changelog_tool.prediction = "## v1.1.0\n- New feature\n- Bug fix"
changelog_tool.changelog_file = "# Changelog\n\n## v1.0.0\n- Initial release"
changelog_tool.commit_changelog = True
# Act
new_content, answer = changelog_tool._prepare_changelog_update()
# Assert
assert new_content.startswith("## v1.1.0\n- New feature\n- Bug fix\n\n")
assert "# Changelog\n\n## v1.0.0\n- Initial release" in new_content
assert answer == "## v1.1.0\n- New feature\n- Bug fix"
def test_prepare_changelog_update_without_existing_content(self, changelog_tool):
"""Test preparing changelog update when no existing content."""
# Arrange
changelog_tool.prediction = "## v1.0.0\n- Initial release"
changelog_tool.changelog_file = ""
changelog_tool.commit_changelog = True
# Act
new_content, answer = changelog_tool._prepare_changelog_update()
# Assert
assert new_content == "## v1.0.0\n- Initial release"
assert answer == "## v1.0.0\n- Initial release"
def test_prepare_changelog_update_no_commit(self, changelog_tool):
"""Test preparing changelog update when not committing."""
# Arrange
changelog_tool.prediction = "## v1.1.0\n- New feature"
changelog_tool.changelog_file = ""
changelog_tool.commit_changelog = False
# Act
new_content, answer = changelog_tool._prepare_changelog_update()
# Assert
assert new_content == "## v1.1.0\n- New feature"
assert "to commit the new content" in answer
@pytest.mark.asyncio
async def test_run_without_push_support(self, changelog_tool, mock_git_provider):
"""Test running changelog update when git provider doesn't support pushing."""
# Arrange
delattr(mock_git_provider, 'create_or_update_pr_file') # Remove the method
changelog_tool.commit_changelog = True
with patch('pr_agent.tools.pr_update_changelog.get_settings') as mock_settings:
mock_settings.return_value.pr_update_changelog.push_changelog_changes = True
mock_settings.return_value.config.publish_output = True
# Act
await changelog_tool.run()
# Assert
mock_git_provider.publish_comment.assert_called_once()
assert "not currently supported" in str(mock_git_provider.publish_comment.call_args)
@pytest.mark.asyncio
async def test_run_with_push_support(self, changelog_tool, mock_git_provider):
"""Test running changelog update when git provider supports pushing."""
# Arrange
mock_git_provider.create_or_update_pr_file = MagicMock()
changelog_tool.commit_changelog = True
changelog_tool.prediction = "## v1.1.0\n- New feature"
with patch('pr_agent.tools.pr_update_changelog.get_settings') as mock_settings, \
patch('pr_agent.tools.pr_update_changelog.retry_with_fallback_models') as mock_retry, \
patch('pr_agent.tools.pr_update_changelog.sleep'):
mock_settings.return_value.pr_update_changelog.push_changelog_changes = True
mock_settings.return_value.pr_update_changelog.get.return_value = True
mock_settings.return_value.config.publish_output = True
mock_settings.return_value.config.git_provider = "gitlab"
mock_retry.return_value = None
# Act
await changelog_tool.run()
# Assert
mock_git_provider.create_or_update_pr_file.assert_called_once()
call_args = mock_git_provider.create_or_update_pr_file.call_args
assert call_args[1]['file_path'] == 'CHANGELOG.md'
assert call_args[1]['branch'] == 'feature-branch'
def test_push_changelog_update(self, changelog_tool, mock_git_provider):
"""Test the push changelog update functionality."""
# Arrange
mock_git_provider.create_or_update_pr_file = MagicMock()
mock_git_provider.get_pr_branch.return_value = "feature-branch"
new_content = "# Updated changelog content"
answer = "Changes made"
with patch('pr_agent.tools.pr_update_changelog.get_settings') as mock_settings, \
patch('pr_agent.tools.pr_update_changelog.sleep'):
mock_settings.return_value.pr_update_changelog.get.return_value = True
# Act
changelog_tool._push_changelog_update(new_content, answer)
# Assert
mock_git_provider.create_or_update_pr_file.assert_called_once_with(
file_path="CHANGELOG.md",
branch="feature-branch",
contents=new_content,
message="[skip ci] Update CHANGELOG.md"
)
def test_gitlab_provider_method_detection(self, changelog_tool, mock_git_provider):
"""Test that the tool correctly detects GitLab provider method availability."""
# Arrange
mock_git_provider.create_or_update_pr_file = MagicMock()
# Act & Assert
assert hasattr(mock_git_provider, "create_or_update_pr_file")
@pytest.mark.parametrize("existing_content,new_entry,expected_order", [
(
"# Changelog\n\n## v1.0.0\n- Old feature",
"## v1.1.0\n- New feature",
["v1.1.0", "v1.0.0"]
),
(
"",
"## v1.0.0\n- Initial release",
["v1.0.0"]
),
(
"Some existing content",
"## v1.0.0\n- New entry",
["v1.0.0", "Some existing content"]
),
])
def test_changelog_order_preservation(self, changelog_tool, existing_content, new_entry, expected_order):
"""Test that changelog entries are properly ordered (newest first)."""
# Arrange
changelog_tool.prediction = new_entry
changelog_tool.changelog_file = existing_content
changelog_tool.commit_changelog = True
# Act
new_content, _ = changelog_tool._prepare_changelog_update()
# Assert
for i, expected in enumerate(expected_order[:-1]):
current_pos = new_content.find(expected)
next_pos = new_content.find(expected_order[i + 1])
assert current_pos < next_pos, f"Expected {expected} to come before {expected_order[i + 1]}"

View File

@ -0,0 +1,69 @@
import pytest
from unittest.mock import MagicMock, patch
from pr_agent.secret_providers import get_secret_provider
class TestSecretProviderFactory:
def test_get_secret_provider_none_when_not_configured(self):
with patch('pr_agent.secret_providers.get_settings') as mock_get_settings:
settings = MagicMock()
settings.get.return_value = None
mock_get_settings.return_value = settings
result = get_secret_provider()
assert result is None
def test_get_secret_provider_google_cloud_storage(self):
with patch('pr_agent.secret_providers.get_settings') as mock_get_settings:
settings = MagicMock()
settings.get.return_value = "google_cloud_storage"
settings.config.secret_provider = "google_cloud_storage"
mock_get_settings.return_value = settings
with patch('pr_agent.secret_providers.google_cloud_storage_secret_provider.GoogleCloudStorageSecretProvider') as MockProvider:
mock_instance = MagicMock()
MockProvider.return_value = mock_instance
result = get_secret_provider()
assert result is mock_instance
MockProvider.assert_called_once()
def test_get_secret_provider_aws_secrets_manager(self):
with patch('pr_agent.secret_providers.get_settings') as mock_get_settings:
settings = MagicMock()
settings.get.return_value = "aws_secrets_manager"
settings.config.secret_provider = "aws_secrets_manager"
mock_get_settings.return_value = settings
with patch('pr_agent.secret_providers.aws_secrets_manager_provider.AWSSecretsManagerProvider') as MockProvider:
mock_instance = MagicMock()
MockProvider.return_value = mock_instance
result = get_secret_provider()
assert result is mock_instance
MockProvider.assert_called_once()
def test_get_secret_provider_unknown_provider(self):
with patch('pr_agent.secret_providers.get_settings') as mock_get_settings:
settings = MagicMock()
settings.get.return_value = "unknown_provider"
settings.config.secret_provider = "unknown_provider"
mock_get_settings.return_value = settings
with pytest.raises(ValueError, match="Unknown SECRET_PROVIDER"):
get_secret_provider()
def test_get_secret_provider_initialization_error(self):
with patch('pr_agent.secret_providers.get_settings') as mock_get_settings:
settings = MagicMock()
settings.get.return_value = "aws_secrets_manager"
settings.config.secret_provider = "aws_secrets_manager"
mock_get_settings.return_value = settings
with patch('pr_agent.secret_providers.aws_secrets_manager_provider.AWSSecretsManagerProvider') as MockProvider:
MockProvider.side_effect = Exception("Initialization failed")
with pytest.raises(ValueError, match="Failed to initialize aws_secrets_manager secret provider"):
get_secret_provider()

View File

@ -32,11 +32,6 @@ age: 35
expected_output = {'name': 'John Smith', 'age': 35}
assert try_fix_yaml(review_text) == expected_output
# The function removes the last line(s) of the YAML string and successfully parses the YAML string.
def test_remove_last_line(self):
review_text = "key: value\nextra invalid line\n"
expected_output = {"key": "value"}
assert try_fix_yaml(review_text) == expected_output
# The YAML string is empty.
def test_empty_yaml_fixed(self):
@ -58,12 +53,12 @@ code_suggestions:
- relevant_file: |
src/index2.ts
label: |
enhancment
enhancement
```
We can further improve the code by using the `const` keyword instead of `var` in the `src/index.ts` file.
'''
expected_output = {'code_suggestions': [{'relevant_file': 'src/index.ts\n', 'label': 'best practice\n'}, {'relevant_file': 'src/index2.ts\n', 'label': 'enhancment'}]}
expected_output = {'code_suggestions': [{'relevant_file': 'src/index.ts\n', 'label': 'best practice\n'}, {'relevant_file': 'src/index2.ts\n', 'label': 'enhancement'}]}
assert try_fix_yaml(review_text, first_key='code_suggestions', last_key='label') == expected_output
@ -81,10 +76,178 @@ code_suggestions:
- relevant_file: |
src/index2.ts
label: |
enhancment
enhancement
```
We can further improve the code by using the `const` keyword instead of `var` in the `src/index.ts` file.
'''
expected_output = {'code_suggestions': [{'relevant_file': 'src/index.ts\n', 'label': 'best practice\n'}, {'relevant_file': 'src/index2.ts\n', 'label': 'enhancment'}]}
expected_output = {'code_suggestions': [{'relevant_file': 'src/index.ts\n', 'label': 'best practice\n'}, {'relevant_file': 'src/index2.ts\n', 'label': 'enhancement'}]}
assert try_fix_yaml(review_text, first_key='code_suggestions', last_key='label') == expected_output
def test_with_brackets_yaml_content(self):
review_text = '''\
{
code_suggestions:
- relevant_file: |
src/index.ts
label: |
best practice
- relevant_file: |
src/index2.ts
label: |
enhancement
}
'''
expected_output = {'code_suggestions': [{'relevant_file': 'src/index.ts\n', 'label': 'best practice\n'}, {'relevant_file': 'src/index2.ts\n', 'label': 'enhancement'}]}
assert try_fix_yaml(review_text, first_key='code_suggestions', last_key='label') == expected_output
def test_tab_indent_yaml(self):
review_text = '''\
code_suggestions:
- relevant_file: |
src/index.ts
label: |
\tbest practice
- relevant_file: |
src/index2.ts
label: |
enhancement
'''
expected_output = {'code_suggestions': [{'relevant_file': 'src/index.ts\n', 'label': 'best practice\n'}, {'relevant_file': 'src/index2.ts\n', 'label': 'enhancement\n'}]}
assert try_fix_yaml(review_text, first_key='code_suggestions', last_key='label') == expected_output
def test_leading_plus_mark_code(self):
review_text = '''\
code_suggestions:
- relevant_file: |
src/index.ts
label: |
best practice
existing_code: |
+ var router = createBrowserRouter([
improved_code: |
+ const router = createBrowserRouter([
'''
expected_output = {'code_suggestions': [{
'relevant_file': 'src/index.ts\n',
'label': 'best practice\n',
'existing_code': 'var router = createBrowserRouter([\n',
'improved_code': 'const router = createBrowserRouter([\n'
}]}
assert try_fix_yaml(review_text, first_key='code_suggestions', last_key='improved_code') == expected_output
def test_inconsistent_indentation_in_block_scalar_yaml(self):
"""
This test case represents a situation where the AI outputs the opening '{' with 5 spaces
(resulting in an inferred indent level of 5), while the closing '}' is output with only 4 spaces.
This inconsistency makes it impossible for the YAML parser to automatically determine the correct
indent level, causing a parsing failure.
The root cause may be the LLM miscounting spaces or misunderstanding the active block scalar context
while generating YAML output.
"""
review_text = '''\
code_suggestions:
- relevant_file: |
tsconfig.json
existing_code: |
{
"key1": "value1",
"key2": {
"subkey": "value"
}
}
'''
expected_json = '''\
{
"key1": "value1",
"key2": {
"subkey": "value"
}
}
'''
expected_output = {
'code_suggestions': [{
'relevant_file': 'tsconfig.json\n',
'existing_code': expected_json
}]
}
assert try_fix_yaml(review_text, first_key='code_suggestions', last_key='existing_code') == expected_output
def test_inconsistent_and_insufficient_indentation_in_block_scalar_yaml(self):
"""
This test case reproduces a YAML parsing failure where the block scalar content
generated by the AI includes inconsistent and insufficient indentation levels.
The root cause may be the LLM miscounting spaces or misunderstanding the active block scalar context
while generating YAML output.
"""
review_text = '''\
code_suggestions:
- relevant_file: |
tsconfig.json
existing_code: |
{
"key1": "value1",
"key2": {
"subkey": "value"
}
}
'''
expected_json = '''\
{
"key1": "value1",
"key2": {
"subkey": "value"
}
}
'''
expected_output = {
'code_suggestions': [{
'relevant_file': 'tsconfig.json\n',
'existing_code': expected_json
}]
}
assert try_fix_yaml(review_text, first_key='code_suggestions', last_key='existing_code') == expected_output
def test_wrong_indentation_code_block_scalar(self):
review_text = '''\
code_suggestions:
- relevant_file: |
a.c
existing_code: |
int sum(int a, int b) {
return a + b;
}
int sub(int a, int b) {
return a - b;
}
'''
expected_code_block = '''\
int sum(int a, int b) {
return a + b;
}
int sub(int a, int b) {
return a - b;
}
'''
expected_output = {
"code_suggestions": [
{
"relevant_file": "a.c\n",
"existing_code": expected_code_block
}
]
}
assert try_fix_yaml(review_text, first_key='code_suggestions', last_key='existing_code') == expected_output