xiaxinhang/pr-agent
1
0
Fork 0
mirror of https://github.com/qodo-ai/pr-agent.git synced 2025-07-21 04:50:39 +08:00
Code Issues Packages Projects Releases Wiki Activity

add docs

Browse Source
This commit is contained in:
Hussam.lawen
2025-07-20 18:15:21 +03:00
parent f42dc28a55
commit 730fa66594
4 changed files with 88 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/docs/core-abilities/fetching_ticket_context.md
View File

@ -104,7 +104,7 @@ Installation steps:
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}
![Jira Cloud App Installation](https://www.qodo.ai/images/pr_agent/jira_app_installation2.png){width=384}
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}

1
docs/docs/tools/index.md
View File

@ -15,6 +15,7 @@ Here is a list of Qodo Merge tools, each with a dedicated page that explains how
| **💎 [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 |
| **💎 [CI Feedback (`/checks ci_job`](./ci_feedback.md))** | Automatically generates feedback and analysis for a failed CI job |
| **💎 [Compliance (`/compliance`](./compliance.md))** | Comprehensive compliance checks for security, ticket requirements, and custom organizational rules |
| **💎 [PR to Ticket (`/create_ticket`](./pr_to_ticket.md))** | Generates ticket in the ticket tracking systems (Jira, Linear, or Git provider issues) based on PR content |
| **💎 [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 |

85
docs/docs/tools/pr_to_ticket.md Normal file
View File

@ -0,0 +1,85 @@
`Platforms supported: GitHub, GitLab, Bitbucket`
## Overview
The `create_ticket` tool automatically generates tickets in ticket tracking systems (`Jira`, `Linear`, or `GitHub 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.
When a ticket is created, it appears in the PR description under an `Auto-created Ticket` section, complete with a link to the generated ticket.
![auto_created_ticket_in_description](https://codium.ai/images/pr_agent/auto_created_ticket_in_description.png){width=256}
!!! info "Pre-requisites"
- To use this tool you need to integrate your ticketing system with Qodo-merge, follow the [Ticket Compliance Documentation](https://qodo-merge-docs.qodo.ai/core-abilities/fetching_ticket_context/).
- For Jira Cloud users, please re-integrate your connection through the [qodo merge integration page](https://app.qodo.ai/qodo-merge/integrations) to enable the `update` permission required for ticket creation
- You need to configure the project key in ticket corresponding to the repository where the PR is created. This is done by adding the `default_project_key`.
```toml
[pr_to_ticket]
default_project_key = "PROJECT_KEY" # e.g., "SCRUM"
```
## Usage
there are 3 ways to use the `create_ticket` tool:
1. [**Automatic Ticket Creation**](#automatic-ticket-creation)
2. [**Interactive Triggering via Compliance Tool**](#interactive-triggering-via-compliance-tool)
3. [**Manual Ticket Creation**](#manual-ticket-creation)
### Automatic Ticket Creation
The tool can be configured to automatically create tickets when a PR is opened or updated and the PR does not already have a ticket associated with it.
This ensures that every code change is documented in the ticketing system without manual intervention.
To configure automatic ticket creation, add the following to `.pr_agnet.toml`:
```toml
[pr_description]
auto_create_ticket = true
```
### Interactive Triggering via Compliance Tool
The tool can be triggered interactively through a checkbox in the compliance tool. This allows users to create tickets as part of their PR Compliance Review workflow.
![ticket creation via compliance tool](https://codium.ai/images/pr_agent/ticket_creation_from_compliance1.png){width=256}
- After clicking the checkbox, the tool will create a ticket and will add/update the `PR Description` with a section called `Auto-created Ticket` with the link to the created ticket.
- Then you can click `update` in the `Ticket compliance` section in the `Compliance` tool
![compliance_auto_created_ticket_final](https://codium.ai/images/pr_agent/compliance_auto_created_ticket_final.png){width=365}
### Manual Ticket Creation
Users can manually trigger the ticket creation process from the PR interface.
To trigger ticket creation manually, the user can call this tool from the PR comment:
```
/create_ticket
```
After triggering, the tool will create a ticket and will add/update the `PR Description` with a section called `Auto-created Ticket` with the link to the created ticket.
## Configuration
## Configuration Options
???+ example "Configuration"
<table>
<tr>
<td><b>default_project_key (required*)</b></td>
<td>The default project key to use when creating tickets. This is required for the tool to create tickets in the ticketing system. Example: `SCRUM`.</td>
</tr>
<tr>
<td><b>default_base_url</b></td>
<td>If your organization have integrated to multiple ticketing systems, you can set the default base URL for the ticketing system. This will be used to create tickets in the default system. Example: `https://YOUR-ORG.atlassian.net`.</td>
</tr>
<tr>
<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>
</tr>
</table>
## Helping Your Organization Meet SOC-2 Requirements
The `create_ticket` tool helps your organization satisfy SOC-2 compliance. By automatically creating tickets from PRs and establishing bidirectional links between them, it ensures every code change is traceable to its corresponding business requirement or task.

1
docs/mkdocs.yml
View File

@ -35,6 +35,7 @@ nav:
- 💎 Analyze: 'tools/analyze.md'
- 💎 CI Feedback: 'tools/ci_feedback.md'
- 💎 Compliance: 'tools/compliance.md'
- 💎 PR to Ticket: 'tools/pr_to_ticket.md'
- 💎 Custom Prompt: 'tools/custom_prompt.md'
- 💎 Generate Labels: 'tools/custom_labels.md'
- 💎 Generate Tests: 'tools/test.md'