mirror of
https://github.com/qodo-ai/pr-agent.git
synced 2025-12-12 02:45:18 +00:00
Merge pull request #1957 from qodo-ai/hl/add_gitlab_issues
update recent updates and add gitlab issues docs
This commit is contained in:
commit
12a01ef5f5
5 changed files with 23 additions and 8 deletions
|
|
@ -9,7 +9,7 @@ This integration enriches the review process by automatically surfacing relevant
|
||||||
|
|
||||||
**Ticket systems supported**:
|
**Ticket systems supported**:
|
||||||
|
|
||||||
- [GitHub](https://qodo-merge-docs.qodo.ai/core-abilities/fetching_ticket_context/#github-issues-integration)
|
- [GitHub/Gitlab Issues](https://qodo-merge-docs.qodo.ai/core-abilities/fetching_ticket_context/#githubgitlab-issues-integration)
|
||||||
- [Jira (💎)](https://qodo-merge-docs.qodo.ai/core-abilities/fetching_ticket_context/#jira-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)
|
- [Linear (💎)](https://qodo-merge-docs.qodo.ai/core-abilities/fetching_ticket_context/#linear-integration)
|
||||||
|
|
||||||
|
|
@ -74,15 +74,18 @@ A `PR Code Verified` label indicates the PR code meets ticket requirements, but
|
||||||
|
|
||||||
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.
|
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
|
## GitHub/Gitlab Issues Integration
|
||||||
|
|
||||||
Qodo Merge will automatically recognize GitHub issues mentioned in the PR description and fetch the issue content.
|
Qodo Merge will automatically recognize GitHub/Gitlab issues mentioned in the PR description and fetch the issue content.
|
||||||
Examples of valid GitHub issue references:
|
Examples of valid GitHub/Gitlab issue references:
|
||||||
|
|
||||||
- `https://github.com/<ORG_NAME>/<REPO_NAME>/issues/<ISSUE_NUMBER>`
|
- `https://github.com/<ORG_NAME>/<REPO_NAME>/issues/<ISSUE_NUMBER>` or `https://gitlab.com/<ORG_NAME>/<REPO_NAME>/-/issues/<ISSUE_NUMBER>`
|
||||||
- `#<ISSUE_NUMBER>`
|
- `#<ISSUE_NUMBER>`
|
||||||
- `<ORG_NAME>/<REPO_NAME>#<ISSUE_NUMBER>`
|
- `<ORG_NAME>/<REPO_NAME>#<ISSUE_NUMBER>`
|
||||||
|
|
||||||
|
Branch names can also be used to link issues, for example:
|
||||||
|
- `123-fix-bug` (where `123` is the issue number)
|
||||||
|
|
||||||
Since Qodo Merge is integrated with GitHub, it doesn't require any additional configuration to fetch GitHub issues.
|
Since Qodo Merge is integrated with GitHub, it doesn't require any additional configuration to fetch GitHub issues.
|
||||||
|
|
||||||
## Jira Integration 💎
|
## Jira Integration 💎
|
||||||
|
|
|
||||||
|
|
@ -7,6 +7,8 @@ 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.
|
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"
|
=== "Recent Updates"
|
||||||
|
- **PR to Ticket**: Generates ticket in your tracking systems based on PR content [Learn more](https://qodo-merge-docs.qodo.ai/tools/pr_to_ticket/).
|
||||||
|
- **Gitlab Issues Support**: Qodo Merge now supports Gitlab issues for ticket context retrieval and ticket creation.
|
||||||
- **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)).
|
- **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))
|
- **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))
|
- **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))
|
||||||
|
|
|
||||||
|
|
@ -68,3 +68,7 @@ description = "Description of when AI should suggest this label"
|
||||||
[custom_labels."Custom Label 2"]
|
[custom_labels."Custom Label 2"]
|
||||||
description = "Description of when AI should suggest this label 2"
|
description = "Description of when AI should suggest this label 2"
|
||||||
```
|
```
|
||||||
|
|
||||||
|
???+ tip "Auto-remove custom label when no longer relevant"
|
||||||
|
If the custom label is no longer relevant, it will be automatically removed from the PR by running the `generate_labels` tool or the `describe` tool.
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -219,6 +219,10 @@ Custom labels can be defined in a [configuration file](https://qodo-merge-docs.q
|
||||||
Make sure to provide proper title, and a detailed and well-phrased description for each label, so the tool will know when to suggest it.
|
Make sure to provide proper title, and a detailed and well-phrased description for each label, so the tool will know when to suggest it.
|
||||||
Each label description should be a **conditional statement**, that indicates if to add the label to the PR or not, according to the PR content.
|
Each label description should be a **conditional statement**, that indicates if to add the label to the PR or not, according to the PR content.
|
||||||
|
|
||||||
|
???+ tip "Auto-remove custom label when no longer relevant"
|
||||||
|
If the custom label is no longer relevant, it will be automatically removed from the PR by running the `generate_labels` tool or the `describe` tool.
|
||||||
|
|
||||||
|
|
||||||
### Handle custom labels from a configuration file
|
### Handle custom labels from a configuration file
|
||||||
|
|
||||||
Example for a custom labels configuration setup in a configuration file:
|
Example for a custom labels configuration setup in a configuration file:
|
||||||
|
|
|
||||||
|
|
@ -1,7 +1,9 @@
|
||||||
`Platforms supported: GitHub, GitLab, Bitbucket`
|
`Platforms supported: GitHub, GitLab, Bitbucket`
|
||||||
|
|
||||||
|
`Supported Ticket providers: Jira, Linear, GitHub Issues, Gitlab Issues`
|
||||||
|
|
||||||
## Overview
|
## Overview
|
||||||
The `create_ticket` tool automatically generates tickets in ticket tracking systems (`Jira`, `Linear`, or `GitHub Issues`) based on PR content.
|
The `create_ticket` tool automatically generates tickets in ticket tracking systems (`Jira`, `Linear`, or `GitHub Issues` and `Gitlab issues`) based on PR content.
|
||||||
|
|
||||||
It analyzes the PR's data (code changes, commit messages, and description) to create well-structured tickets that capture the essence of the development work, helping teams maintain traceability between code changes and project management systems.
|
It analyzes the PR's data (code changes, commit messages, and description) to create well-structured tickets that capture the essence of the development work, helping teams maintain traceability between code changes and project management systems.
|
||||||
|
|
||||||
|
|
@ -78,7 +80,7 @@ After triggering, the tool will create a ticket and will add/update the `PR Desc
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td><b>fallback_to_git_provider_issues</b></td>
|
<td><b>fallback_to_git_provider_issues</b></td>
|
||||||
<td>If set to `true`, the tool will create issues in the Git provider's issue tracker (GitHub) if the `default_project_key` is not configured in the repository configuration. Default is `false`.</td>
|
<td>If set to `true`, the tool will create issues in the Git provider's issue tracker (GitHub, Gitlab) if the `default_project_key` is not configured in the repository configuration. Default is `false`.</td>
|
||||||
</tr>
|
</tr>
|
||||||
</table>
|
</table>
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue