|
1 | 1 | --- |
2 | | -title: Integrate CodeRabbit with Jira |
| 2 | +title: Utilize CodeRabbit with Jira |
3 | 3 | description: Integrate CodeRabbit with Jira. |
4 | | -sidebar_label: Link Issues with Pull Request |
| 4 | +sidebar_label: Linked and Related Issues |
5 | 5 | image: "/preview_meta.jpg" |
6 | 6 | --- |
7 | 7 |
|
8 | 8 | <head> |
9 | 9 | <meta charSet="utf-8" /> |
10 | | - <meta name="title" content="Connect CodeRabbit with Jira" /> |
| 10 | + <meta name="title" content="Utilize CodeRabbit with Jira" /> |
11 | 11 | <meta name="description" content="Integrate CodeRabbit with Jira" /> |
12 | 12 |
|
13 | 13 | <meta property="og:type" content="website" /> |
14 | 14 | <meta property="og:url" content="https://coderabbit.ai/" /> |
15 | | - <meta property="og:title" content="Connect CodeRabbit with Jira" /> |
| 15 | + <meta property="og:title" content="Utilize CodeRabbit with Jira" /> |
16 | 16 | <meta property="og:description" content="CodeRabbit: AI-powered Code Reviews" /> |
17 | 17 | <meta property="og:image" content="/preview_meta.jpg" /> |
18 | 18 |
|
19 | 19 | <meta name="twitter:image" content="https://coderabbit.ai/preview_meta.jpg" /> |
20 | 20 | <meta name="twitter:card" content="summary_large_image" /> |
21 | | - <meta name="twitter:title" content="Connect CodeRabbit with Jira" /> |
| 21 | + <meta name="twitter:title" content="Utilize CodeRabbit with Jira" /> |
22 | 22 | <meta name="twitter:description" content="CodeRabbit: AI-powered Code Reviews" /> |
23 | 23 | </head> |
| 24 | + |
| 25 | +### Linking Issues |
| 26 | + |
| 27 | +After successfully integrating CodeRabbit with Jira, you gain the ability to link Jira issues directly to your pull requests. |
| 28 | + |
| 29 | +Linking Issues with Pull Requests |
| 30 | +To link a Jira issue to a pull request, simply include the Jira Issue ID in the pull request description. For instance: |
| 31 | + |
| 32 | +Jira issue: TEK-01 |
| 33 | + |
| 34 | +This indicates that the pull request addresses a specific issue, such as fixing a bug. When the pull request is submitted with the associated Jira Issue ID, CodeRabbit automatically retrieves the corresponding issue and evaluates whether the pull request fulfills its objectives. |
| 35 | + |
| 36 | +:::info |
| 37 | +You can view the assessment outcome in the Walkthrough section. |
| 38 | +::: |
| 39 | + |
| 40 | +Upon posting the review findings, CodeRabbit provides details about the issue's objectives, confirms whether they were met, and offers additional explanations if needed. |
| 41 | + |
| 42 | +### Finding Related Issues |
| 43 | + |
| 44 | +One of the key features of CodeRabbit's Jira integration is its ability to discover related issues. Leveraging RAG (Retrieval-Augmented Generation), CodeRabbit enhances its AI capabilities. RAG empowers AI models to incorporate external data sources beyond their training sets or predefined parameters, thereby enhancing their responses to given prompts. |
| 45 | + |
| 46 | +After integrating with Jira, CodeRabbit scans through open issues, indexing them for future reference. This means that pre-existing issues are retrieved, indexed into a Vector database, and subsequently searched for each new pull request. |
| 47 | + |
| 48 | +:::info |
| 49 | +Indexing occurs periodically on a scheduled basis. As a result, newly created issues or those not yet scheduled for indexing may not be immediately detected by CodeRabbit. |
| 50 | +::: |
| 51 | + |
| 52 | +If any related issues are identified, CodeRabbit highlights them, providing insights into the pull request's coverage and facilitating collaboration between developers and reviewers. |
0 commit comments