Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update from upstream #9

Closed
wants to merge 65 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
65 commits
Select commit Hold shift + click to select a range
8610aa2
Add disable_auto_feedback configuration option to control automatic P…
mrT23 Dec 2, 2024
1dd5f0b
Merge pull request #1379 from Codium-ai/tr/disable_auto_commands
mrT23 Dec 2, 2024
43c9510
Update fetching_ticket_context.md
hussam789 Dec 3, 2024
fe20a8c
docs: update Qodo Merge Pro installation documentation with rebrandin…
mrT23 Dec 3, 2024
7d99c0d
Merge remote-tracking branch 'origin/main'
mrT23 Dec 3, 2024
d9f9cc6
Merge pull request #1380 from Codium-ai/hl/ticket_docs_update
hussam789 Dec 3, 2024
84c3a7b
docs: update Qodo Merge Pro installation documentation with Bitbucket…
mrT23 Dec 3, 2024
9160f75
docs: update Qodo Merge Pro installation documentation with Bitbucket…
mrT23 Dec 3, 2024
d26ca4f
docs: update Qodo Merge Pro installation documentation with Bitbucket…
mrT23 Dec 3, 2024
10f8b52
Merge pull request #1381 from Codium-ai/tr/qodo_installation
mrT23 Dec 3, 2024
19ade4a
fixed link
mrT23 Dec 4, 2024
39a461b
docs: update badges and clarify Qodo Merge Pro description
mrT23 Dec 5, 2024
43e91b0
feat: add health test for PR agent commands and improve output handling
mrT23 Dec 8, 2024
e8fc351
docs: add CLI health check section and reorganize automations documen…
mrT23 Dec 8, 2024
7d5e59c
Update tests/health_test/main.py
mrT23 Dec 8, 2024
1588920
Merge pull request #1386 from Codium-ai/tr/self_check
mrT23 Dec 8, 2024
e68e100
typo
mrT23 Dec 8, 2024
683108d
Removed model_turbo
KennyDizi Dec 8, 2024
a4d9a65
Add model_week
KennyDizi Dec 8, 2024
dec2859
Set default model to weak model
KennyDizi Dec 8, 2024
936894e
Use regular model for pr review and code suggestion flows
KennyDizi Dec 8, 2024
fc5dda0
Use weak model for the rest flows
KennyDizi Dec 8, 2024
3c31048
Update model in git provider
KennyDizi Dec 8, 2024
88a93bd
Update weak model document
KennyDizi Dec 8, 2024
e3d779c
Fix typo model_weak
KennyDizi Dec 8, 2024
7dc9e73
fix: move user_tag variable declaration outside conditional block
mrT23 Dec 9, 2024
9e25667
docs: reorganize and enhance best practices documentation in improve.md
mrT23 Dec 9, 2024
c45cde9
docs: fix typos in improve.md documentation
mrT23 Dec 9, 2024
e11cec7
Merge pull request #1388 from Codium-ai/tr/readme_enhancments
mrT23 Dec 9, 2024
f49217e
docs: fix typos in improve.md documentation
mrT23 Dec 9, 2024
6352e6e
Change default model to regular model
KennyDizi Dec 9, 2024
f9a7b18
Improve condition to pick up weak model
KennyDizi Dec 9, 2024
75a1209
Add version metadata and --version command
MarkRx Dec 9, 2024
a61f188
fix doc
glebzhidkov Dec 10, 2024
c6eb253
Merge pull request #1390 from glebzhidkov/docs/escape-list-in-yaml-file
mrT23 Dec 10, 2024
d34edb8
feat: add thumbs up/down support and refactor code suggestions handling
mrT23 Dec 11, 2024
6a51b85
docs: add allow_thumbs_up_down configuration option and remove rank_e…
mrT23 Dec 11, 2024
da786b8
Merge pull request #1391 from Codium-ai/tr/thumbs_up_down
mrT23 Dec 11, 2024
cb88489
Merge pull request #1387 from KennyDizi/main
mrT23 Dec 11, 2024
872b27b
docs: remove model_weak configuration and simplify model selection
mrT23 Dec 11, 2024
f67cc0d
Merge pull request #1392 from Codium-ai/tr/model_weak
mrT23 Dec 11, 2024
c4dc263
docs: update repository reference to be platform-agnostic
mrT23 Dec 11, 2024
3d38060
Update README.md
mrT23 Dec 12, 2024
184a52d
Update README.md
mrT23 Dec 12, 2024
1a77e9a
Update README.md
mrT23 Dec 13, 2024
048ae8e
Update README.md
mrT23 Dec 13, 2024
5e5c251
Merge pull request #1394 from Codium-ai/mrT23-patch-6
mrT23 Dec 13, 2024
0be2750
Update review.md
mrT23 Dec 14, 2024
bbec5d9
Merge pull request #1395 from Codium-ai/mrT23-patch-6
mrT23 Dec 14, 2024
721d38d
docs: add license information to similar code documentation
ofir-frd Dec 16, 2024
03d2bea
Add support model gemini-2.0-flash-exp
KennyDizi Dec 16, 2024
57089c9
Merge pull request #1396 from ofir-frd/add-pr-body-license-documentation
mrT23 Dec 16, 2024
d0ea901
Update fetching_ticket_context.md
mrT23 Dec 16, 2024
9ef9198
Update index.md
mrT23 Dec 16, 2024
a768969
Merge pull request #1397 from KennyDizi/main
mrT23 Dec 16, 2024
452abe2
Move get_version to algo/util.py; fix version to 0.25
MarkRx Dec 17, 2024
f3ee4a7
docs: simplify default tool configurations and update documentation
mrT23 Dec 19, 2024
e9615c6
Merge pull request #1384 from MarkRx/feature/version-metadata
mrT23 Dec 19, 2024
d09aa1b
docs: remove unused automatic_review configuration option
mrT23 Dec 19, 2024
8478649
Merge pull request #1401 from Codium-ai/tr/docs3
mrT23 Dec 19, 2024
7e8361b
feat: enhance code review output with collapsible code snippets and v…
mrT23 Dec 19, 2024
989670b
fix: improve markdown rendering when git provider is unavailable
mrT23 Dec 19, 2024
3ab2cac
fix: improve markdown rendering when git provider is unavailable
mrT23 Dec 19, 2024
c2f1f2d
fix: improve markdown rendering when git provider is unavailable
mrT23 Dec 19, 2024
c9f02e6
Merge pull request #1403 from Codium-ai/tr/re_review
mrT23 Dec 20, 2024
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
75 changes: 36 additions & 39 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,15 +13,13 @@
Qode Merge PR-Agent aims to help efficiently review and handle pull requests, by providing AI feedback and suggestions
</div>

[![GitHub license](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://github.com/Codium-ai/pr-agent/blob/main/LICENSE)
[![Static Badge](https://img.shields.io/badge/Chrome-Extension-violet)](https://chromewebstore.google.com/detail/pr-agent-chrome-extension/ephlnjeghhogofkifjloamocljapahnl)
[![Static Badge](https://img.shields.io/badge/Code-Benchmark-blue)](https://pr-agent-docs.codium.ai/finetuning_benchmark/)
[![Static Badge](https://img.shields.io/badge/Pro-App-blue)](https://github.com/apps/qodo-merge-pro/)
[![Static Badge](https://img.shields.io/badge/OpenSource-App-red)](https://github.com/apps/qodo-merge-pro-for-open-source/)
[![Discord](https://badgen.net/badge/icon/discord?icon=discord&label&color=purple)](https://discord.com/channels/1057273017547378788/1126104260430528613)
[![Twitter](https://img.shields.io/twitter/follow/codiumai)](https://twitter.com/codiumai)
[![Cheat Sheet](https://img.shields.io/badge/Cheat-Sheet-red)](https://www.codium.ai/images/pr_agent/cheat_sheet.pdf)
<a href="https://github.com/Codium-ai/pr-agent/commits/main">
<img alt="GitHub" src="https://img.shields.io/github/last-commit/Codium-ai/pr-agent/main?style=for-the-badge" height="20">
</a>
<a href="https://github.com/Codium-ai/pr-agent/commits/main">
<img alt="GitHub" src="https://img.shields.io/github/last-commit/Codium-ai/pr-agent/main?style=for-the-badge" height="20">
</a>
</div>

### [Documentation](https://pr-agent-docs.codium.ai/)
Expand All @@ -45,10 +43,12 @@ Qode Merge PR-Agent aims to help efficiently review and handle pull requests, by

### December 2, 2024

Open-source repositories can now freely use Qodo Merge Pro, and enjoy easy one-click installation using our dedicated [app](https://github.com/apps/qodo-merge-pro-for-open-source).
Open-source repositories can now freely use Qodo Merge Pro, and enjoy easy one-click installation using a marketplace [app](https://github.com/apps/qodo-merge-pro-for-open-source).

<kbd><img src="https://github.com/user-attachments/assets/b0838724-87b9-43b0-ab62-73739a3a855c" width="512"></kbd>

See [here](https://qodo-merge-docs.qodo.ai/installation/pr_agent_pro/) for more details about installing Qodo Merge Pro for private repositories.


### November 18, 2024

Expand All @@ -73,7 +73,7 @@ Focused mode

### November 4, 2024

Qodo Merge PR Agent will now leverage context from Jira or GitHub tickets to enhance the PR Feedback. Read more about this feature
Qodo Merge PR Agent will now leverage context from Jira or GitHub tickets to enhance the PR Feedback. Read more about this feature
[here](https://qodo-merge-docs.qodo.ai/core-abilities/fetching_ticket_context/)


Expand All @@ -82,39 +82,41 @@ Qodo Merge PR Agent will now leverage context from Jira or GitHub tickets to enh

Supported commands per platform:

| | | GitHub | Gitlab | Bitbucket | Azure DevOps |
| | | GitHub | GitLab | Bitbucket | Azure DevOps |
|-------|---------------------------------------------------------------------------------------------------------|:--------------------:|:--------------------:|:--------------------:|:------------:|
| TOOLS | Review | ✅ | ✅ | ✅ | ✅ |
| | ⮑ Incremental | ✅ | | | |
| | Describe | ✅ | ✅ | ✅ | ✅ |
| | ⮑ [Inline File Summary](https://pr-agent-docs.codium.ai/tools/describe#inline-file-summary) 💎 | ✅ | | | |
| | Improve | ✅ | ✅ | ✅ | ✅ |
| | ⮑ Extended | ✅ | ✅ | ✅ | ✅ |
| | Ask | ✅ | ✅ | ✅ | ✅ |
| 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://pr-agent-docs.codium.ai/tools/ask#ask-lines) | ✅ | ✅ | | |
| | [Custom Prompt](https://pr-agent-docs.codium.ai/tools/custom_prompt/) 💎 | ✅ | ✅ | ✅ | |
| | [Test](https://pr-agent-docs.codium.ai/tools/test/) 💎 | ✅ | ✅ | | |
| | Reflect and Review | ✅ | ✅ | ✅ | ✅ |
| | Update CHANGELOG.md | ✅ | ✅ | ✅ | ✅ |
| | Find Similar Issue | ✅ | | | |
| | [Add PR Documentation](https://pr-agent-docs.codium.ai/tools/documentation/) 💎 | ✅ | ✅ | | |
| | [Update CHANGELOG](https://qodo-merge-docs.qodo.ai/tools/update_changelog/) | ✅ | ✅ | ✅ | ✅ |
| | [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://pr-agent-docs.codium.ai/tools/ci_feedback/) 💎 | ✅ | | | |
| | [PR Documentation](https://pr-agent-docs.codium.ai/tools/documentation/) 💎 | ✅ | ✅ | | |
| | [Custom Labels](https://pr-agent-docs.codium.ai/tools/custom_labels/) 💎 | ✅ | ✅ | | |
| | [Analyze](https://pr-agent-docs.codium.ai/tools/analyze/) 💎 | ✅ | ✅ | | |
| | [CI Feedback](https://pr-agent-docs.codium.ai/tools/ci_feedback/) 💎 | ✅ | | | |
| | [Similar Code](https://pr-agent-docs.codium.ai/tools/similar_code/) 💎 | ✅ | | | |
| | [Custom Prompt](https://pr-agent-docs.codium.ai/tools/custom_prompt/) 💎 | ✅ | ✅ | ✅ | |
| | [Test](https://pr-agent-docs.codium.ai/tools/test/) 💎 | ✅ | ✅ | | |
| | | | | | |
| USAGE | CLI | ✅ | ✅ | ✅ | ✅ |
| | App / webhook | ✅ | ✅ | ✅ | ✅ |
| | Tagging bot | ✅ | | | |
| | Actions | ✅ |✅| ✅ |✅|
| 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 | ✅ | ✅ | ✅ | ✅ |
| | Repo language prioritization | ✅ | ✅ | ✅ | ✅ |
| CORE | [PR compression](https://qodo-merge-docs.qodo.ai/core-abilities/compression_strategy/) | ✅ | ✅ | ✅ | ✅ |
| | Adaptive and token-aware file patch fitting | ✅ | ✅ | ✅ | ✅ |
| | Multiple models support | ✅ | ✅ | ✅ | ✅ |
| | [Static code analysis](https://pr-agent-docs.codium.ai/core-abilities/#static-code-analysis) 💎 | ✅ | ✅ | ✅ | |
| | [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://pr-agent-docs.codium.ai/usage-guide/configuration_options/) 💎 | ✅ | ✅ | ✅ | |
| | [PR interactive actions](https://www.codium.ai/images/pr_agent/pr-actions.mp4) 💎 | ✅ | ✅ | | |
| | [Impact Evaluation](https://qodo-merge-docs.qodo.ai/core-abilities/impact_evaluation/) 💎 | ✅ | ✅ | | |
- 💎 means this feature is available only in [PR-Agent Pro](https://www.codium.ai/pricing/)

[//]: # (- Support for additional git providers is described in [here]&#40;./docs/Full_environments.md&#41;)
Expand Down Expand Up @@ -175,14 +177,9 @@ ___
</kbd>
</p>
</div>
<hr>

<h4><a href="https://github.com/Codium-ai/pr-agent/pull/530">/generate_labels</a></h4>
<div align="center">
<p float="center">
<kbd><img src="https://www.codium.ai/images/pr_agent/geneare_custom_labels_main_short.png" width="300"></kbd>
</p>
</div>



[//]: # (<h4><a href="https://github.com/Codium-ai/pr-agent/pull/78#issuecomment-1639739496">/reflect_and_review:</a></h4>)

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/chrome-extension/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.5 Sonnet and GPT4. All the extension's features are free to use on public repositories.

For private repositories, you will need to install [Qodo Merge Pro](https://github.com/apps/codiumai-pr-agent-pro) in addition to the extension (Quick GitHub app setup with a 14-day free trial. No credit card needed).
For private repositories, you will need to install [Qodo Merge Pro](https://github.com/apps/qodo-merge-pro) in addition to the extension (Quick GitHub app setup with a 14-day free trial. No credit card needed).
For a demonstration of how to install Qodo Merge Pro and use it with the Chrome extension, please refer to the tutorial video at the provided [link](https://codium.ai/images/pr_agent/private_repos.mp4).

<img src="https://codium.ai/images/pr_agent/PR-AgentChat.gif" width="768">
Expand Down
33 changes: 26 additions & 7 deletions docs/docs/core-abilities/fetching_ticket_context.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,29 @@
# Fetching Ticket Context for PRs
`Supported Git Platforms : GitHub, GitLab, Bitbucket`

## Overview
Qodo Merge PR Agent streamlines code review workflows by seamlessly connecting with multiple ticket management systems.
This integration enriches the review process by automatically surfacing relevant ticket information and context alongside code changes.

## Ticket systems supported
- GitHub
- Jira (💎)

Ticket data fetched:

1. Ticket Title
2. Ticket Description
3. Custom Fields (Acceptance criteria)
4. Subtasks (linked tasks)
5. Labels
6. Attached Images/Screenshots

## Affected Tools

Ticket Recognition Requirements:

1. The PR description should contain a link to the ticket.
2. For Jira tickets, you should follow the instructions in [Jira Integration](https://qodo-merge-docs.qodo.ai/core-abilities/fetching_ticket_context/#jira-integration) in order to authenticate with Jira.

- The PR description should contain a link to the ticket or if the branch name starts with the ticket id / number.
- For Jira tickets, you should follow the instructions in [Jira Integration](https://qodo-merge-docs.qodo.ai/core-abilities/fetching_ticket_context/#jira-integration) in order to authenticate with Jira.

### Describe tool
Qodo Merge PR Agent will recognize the ticket and use the ticket content (title, description, labels) to provide additional context for the code changes.
Expand Down Expand Up @@ -49,12 +62,18 @@ Since Qodo Merge PR Agent is integrated with GitHub, it doesn't require any addi
### Jira Integration 💎

We support both Jira Cloud and Jira Server/Data Center.
To integrate with Jira, The PR Description should contain a link to the Jira ticket.
To integrate with Jira, you can link your PR to a ticket using either of these methods:

For Jira integration, 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`.
**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.

**Method 2: Branch Name Detection:**

Name your branch with the ticket ID as a prefix (e.g., `ISSUE-123-feature-description` or `ISSUE-123/feature-description`).

!!! note "Jira Base URL"
If using the shortened format, ensure your configuration file contains the Jira base URL under the [jira] section like this:
For shortened ticket IDs or branch detection (method 2), you must configure the Jira base URL in your configuration file under the [jira] section:

```toml
[jira]
Expand Down Expand Up @@ -112,4 +131,4 @@ Currently, we only support the Personal Access Token (PAT) Authentication method
[jira]
jira_base_url = "YOUR_JIRA_BASE_URL" # e.g. https://jira.example.com
jira_api_token = "YOUR_API_TOKEN"
```
```
2 changes: 1 addition & 1 deletion docs/docs/core-abilities/static_code_analysis.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ Or be triggered interactively by using the `analyze` tool.

### Find Similar Code

The [`similar code`](https://qodo-merge-docs.qodo.ai/tools/similar_code/) tool retrieves the most similar code components from inside the organization's codebase, or from open-source code.
The [`similar code`](https://qodo-merge-docs.qodo.ai/tools/similar_code/) tool retrieves the most similar code components from inside the organization's codebase or from open-source code, including details about the license associated with each repository.

For example:

Expand Down
Loading
Loading