Add Documentation for Linear and Jira Integration #26
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,50 @@ | ||
| --- | ||
| title: Jira Integration | ||
| description: Integrate CodeRabbit with Jira. | ||
| sidebar_label: Linked and Related Issues | ||
| image: "/preview_meta.jpg" | ||
| --- | ||
|
|
||
| <head> | ||
| <meta charSet="utf-8" /> | ||
| <meta name="title" content="Utilize CodeRabbit with Jira" /> | ||
| <meta name="description" content="Integrate CodeRabbit with Jira" /> | ||
|
|
||
| <meta property="og:type" content="website" /> | ||
| <meta property="og:url" content="https://coderabbit.ai/" /> | ||
| <meta property="og:title" content="Utilize CodeRabbit with Jira" /> | ||
| <meta property="og:description" content="CodeRabbit: AI-powered Code Reviews" /> | ||
| <meta property="og:image" content="/preview_meta.jpg" /> | ||
|
|
||
| <meta name="twitter:image" content="https://coderabbit.ai/preview_meta.jpg" /> | ||
| <meta name="twitter:card" content="summary_large_image" /> | ||
| <meta name="twitter:title" content="Utilize CodeRabbit with Jira" /> | ||
| <meta name="twitter:description" content="CodeRabbit: AI-powered Code Reviews" /> | ||
| </head> | ||
|
|
||
| ### Linking Issues | ||
|
|
||
| After successfully integrating CodeRabbit with Jira, you gain the ability to link Jira issues directly to your pull requests. | ||
|
|
||
| To link a Jira issue to a pull request, simply include the Jira Issue ID in the pull request description. For instance: | ||
|
|
||
| Jira issue: TEK-01 | ||
|
|
||
| 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. | ||
|
|
||
| :::info | ||
| You can view the assessment outcome in the Walkthrough section of CodeRabbit's Review | ||
| ::: | ||
|
|
||
| Upon posting the review findings, CodeRabbit provides details about the issue's objectives, confirms whether they were met, and offers additional explanations if needed. | ||
|
|
||
| ### Finding Related Issues | ||
|
|
||
| One of the key features of CodeRabbit's Jira integration is its ability to discover existing related Jira issues addressed in the pull request. 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. | ||
|
|
||
| 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. | ||
| :::info | ||
| 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. | ||
| ::: | ||
|
|
||
| If any related issues are identified, CodeRabbit highlights them, providing insights into the pull request's coverage and facilitating collaboration between developers and reviewers. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,61 @@ | ||
| --- | ||
| title: Integrate CodeRabbit with Jira | ||
| description: Integrate CodeRabbit with Jira. | ||
| sidebar_label: Setup | ||
| image: "/preview_meta.jpg" | ||
| --- | ||
|
|
||
| <head> | ||
| <meta charSet="utf-8" /> | ||
| <meta name="title" content="Connect CodeRabbit with Jira" /> | ||
| <meta name="description" content="Integrate CodeRabbit with Jira" /> | ||
|
|
||
| <meta property="og:type" content="website" /> | ||
| <meta property="og:url" content="https://coderabbit.ai/" /> | ||
| <meta property="og:title" content="Connect CodeRabbit with Jira" /> | ||
| <meta property="og:description" content="CodeRabbit: AI-powered Code Reviews" /> | ||
| <meta property="og:image" content="/preview_meta.jpg" /> | ||
|
|
||
| <meta name="twitter:image" content="https://coderabbit.ai/preview_meta.jpg" /> | ||
| <meta name="twitter:card" content="summary_large_image" /> | ||
| <meta name="twitter:title" content="Connect CodeRabbit with Jira" /> | ||
| <meta name="twitter:description" content="CodeRabbit: AI-powered Code Reviews" /> | ||
| </head> | ||
|
|
||
| Jira is a widely-used project management tool that helps teams organize tasks, track progress, and collaborate effectively. With Jira, teams can create issues to represent tasks, bugs, or features, assign them to team members, set due dates, and monitor their status throughout the project lifecycle. | ||
|
|
||
| :::note | ||
| Visit [Jira](https://www.atlassian.com/software/jira) if you're unfamiliar and would like to learn more. | ||
| ::: | ||
|
|
||
| As your team works on resolving Jira issues, CodeRabbit automatically assesses the changes made in the associated pull requests, helping you meet project objectives and maintain code quality standards. | ||
|
|
||
| ### Connect CodeRabbit with Jira | ||
|
|
||
|  | ||
|  | ||
|
|
||
| Visit the integrations page by selecting Integrations on the left sidebar on the webapp. On this page, toggle the button for the Jira Integration. | ||
|
|
||
|  | ||
|  | ||
|
|
||
| Once toggling, you will be redirected over to Jira's authorization page. If you are not signed in, please sign in with your Jira credentials. | ||
|
|
||
|  | ||
|  | ||
|
|
||
| Lastly, Jira will ask you to authorize CodeRabbit for read access to Jira Issues and read/write access to manage webhooks. | ||
|
|
||
|  | ||
|  | ||
|
|
||
| **That's It!** Jira will redirect you back to the CodeRabbit integrations page where you should see the toggle enabled for the Jira Integration. | ||
|
|
||
| ### Disconnect CodeRabbit with Jira | ||
|
|
||
| Disconnecting the integration is seamless. Just toggle the button off for the Jira Integration and CodeRabbit will automatically disconnect. | ||
|
|
||
| --- | ||
|
|
||
| Next we will look at how we can link Jira issues and see how CodeRabbit assess them within the Pull Request. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,51 @@ | ||
| --- | ||
| title: Linear Integration | ||
| description: Utilize CodeRabbit with Linear. | ||
| sidebar_label: Linked and Related Issues | ||
| image: "/preview_meta.jpg" | ||
| --- | ||
|
|
||
| <head> | ||
| <meta charSet="utf-8" /> | ||
| <meta name="title" content="Utilize CodeRabbit with Linear" /> | ||
| <meta name="description" content="Integrate CodeRabbit with Linear" /> | ||
|
|
||
| <meta property="og:type" content="website" /> | ||
| <meta property="og:url" content="https://coderabbit.ai/" /> | ||
| <meta property="og:title" content="Utilize CodeRabbit with Linear" /> | ||
| <meta property="og:description" content="CodeRabbit: AI-powered Code Reviews" /> | ||
| <meta property="og:image" content="/preview_meta.jpg" /> | ||
|
|
||
| <meta name="twitter:image" content="https://coderabbit.ai/preview_meta.jpg" /> | ||
| <meta name="twitter:card" content="summary_large_image" /> | ||
| <meta name="twitter:title" content="Utilize CodeRabbit with Linear" /> | ||
| <meta name="twitter:description" content="CodeRabbit: AI-powered Code Reviews" /> | ||
| </head> | ||
|
|
||
| ### Linking Issues | ||
|
|
||
| After successfully integrating CodeRabbit with Linear, you gain the ability to link Linear issues directly to your pull requests. | ||
|
|
||
| To link a Linear issue to a pull request, simply include the Linear Issue ID in the pull request description. | ||
|
|
||
| For instance: | ||
|
|
||
| Linear issue: **_COD-86_** | ||
|
|
||
|  | ||
|
|
||
| This indicates that the pull request addresses a specific issue, such as adding a new feature. In this simple example, the issue created on linear specified to implement the division functionality for the simple calculator. | ||
|
|
||
| When the pull request is submitted with the associated Linear Issue ID, CodeRabbit automatically retrieves the corresponding issue and evaluates whether the pull request fulfills its objectives. | ||
|
|
||
| :::info | ||
| You can view the assessment outcome in the Walkthrough section of CodeRabbit's Review. | ||
| ::: | ||
|
|
||
| Upon posting the review findings, CodeRabbit provides details about the issue's objectives, confirms whether they were met, and offers additional explanations if needed. For example, here, the developer added the division functionality for the simple calculator in the pull request. CodeRabbit was able to find that issue, assess whether the pull request did indeed resolve the issue, and provided the assessment as seen below. | ||
|
|
||
|  | ||
|
|
||
| ### Finding Related Issues | ||
|
|
||
| Another key feature of CodeRabbit's Linear integration is its ability to discover existing related Linear issues addressed in a pull request. Leveraging RAG (Retrieval-Augmented Generation) as described in [Jira Integration - Finding Related Issues](../Jira/link#finding-related-issues) | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,61 @@ | ||
| --- | ||
| title: Integrate CodeRabbit with Linear | ||
| description: Integrate CodeRabbit with Linear. | ||
| sidebar_label: Setup | ||
| image: "/preview_meta.jpg" | ||
| --- | ||
|
|
||
| <head> | ||
| <meta charSet="utf-8" /> | ||
| <meta name="title" content="Connect CodeRabbit with Linear" /> | ||
| <meta name="description" content="Integrate CodeRabbit with Linear" /> | ||
|
|
||
| <meta property="og:type" content="website" /> | ||
| <meta property="og:url" content="https://coderabbit.ai/" /> | ||
| <meta property="og:title" content="Connect CodeRabbit with Linear" /> | ||
| <meta property="og:description" content="CodeRabbit: AI-powered Code Reviews" /> | ||
| <meta property="og:image" content="/preview_meta.jpg" /> | ||
|
|
||
| <meta name="twitter:image" content="https://coderabbit.ai/preview_meta.jpg" /> | ||
| <meta name="twitter:card" content="summary_large_image" /> | ||
| <meta name="twitter:title" content="Connect CodeRabbit with Linear" /> | ||
| <meta name="twitter:description" content="CodeRabbit: AI-powered Code Reviews" /> | ||
| </head> | ||
|
|
||
| Linear is the project planning tool for teams dedicated to quality. Like Jira, it facilitates task organization, progress tracking, and seamless collaboration. Users can create issues to outline tasks, bugs, or features, assign them, set deadlines, and monitor their progress across the project lifecycle. | ||
|
|
||
| :::note | ||
| Visit [Linear](https://linear.app/) if you're unfamiliar and would like to learn more. | ||
| ::: | ||
|
|
||
| As your team works on resolving Linear issues, CodeRabbit automatically assesses the changes made in the associated pull requests, helping you meet project objectives and maintain code quality standards. | ||
|
|
||
| ### Connect CodeRabbit with Linear | ||
|
|
||
|  | ||
|  | ||
|
|
||
| On this page, toggle the button for the Linear Integration. | ||
|
|
||
|  | ||
|  | ||
|
|
||
| Once toggling, you will be redirected over to Linear's authorization page. If you are not signed in, please sign in with your Linear credentials. | ||
|
|
||
|  | ||
|  | ||
|
|
||
| Lastly, Linear will ask you to authorize CodeRabbit for read access. | ||
|
|
||
|  | ||
|  | ||
|
|
||
| **That's It!** Linear will redirect you back to the CodeRabbit integrations page where you should see the toggle enabled for the Linear Integration. | ||
|
|
||
| ### Disconnect CodeRabbit with Linear | ||
|
|
||
| Disconnecting the integration is seamless. Just toggle the button off for the Linear Integration and CodeRabbit will automatically disconnect. | ||
|
|
||
| --- | ||
|
|
||
| Next we will look at how we can link Linear Issues with pull requests and see how CodeRabbit assess them within the Pull Request. |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -11,22 +11,22 @@ To initiate the integration, we require specific information. This is essential | |||||
| for the initial setup of CodeRabbit within your domain. Once this setup is | ||||||
| complete, you can log in directly using the OAuth2 flow. | ||||||
|
|
||||||
| ### 1. Getting Started | ||||||
|
|
||||||
| **Visit CodeRabbit:** Land on to our [Login](https://coderabbit.ai/login) page | ||||||
| and select Self-Hosted GitLab | ||||||
|
|
||||||
|  | ||||||
|
|
||||||
| ### 2. Enter your Self Managed GitLab URL | ||||||
|
There was a problem hiding this comment. The instructions for entering the Self Managed GitLab URL are clear. However, the term "Self Managed" should be hyphenated ("Self-Managed") for consistency with the rest of the documentation. - Enter your Self Managed GitLab URL
+ Enter your Self-Managed GitLab URLCommittable suggestion
Suggested change
There was a problem hiding this comment. For future reviews, throughly check and recommend any improvements for grammatical or syntactical errors There was a problem hiding this comment. @karan925, thank you for your feedback. I'll ensure to thoroughly check and recommend improvements for grammatical or syntactical errors in future reviews. For the current content, I've noted your suggestion for hyphenating "Self-Managed" for consistency, which is a great catch. If there are specific sections you're concerned about or would like me to review again, please let me know! New Learnings Added
|
||||||
|
|
||||||
| On this page, enter the URL of your self managed GitLab instance and click | ||||||
| submit. Once, you submit, we check our database for a record of your | ||||||
| organization. | ||||||
|
|
||||||
|  | ||||||
|
|
||||||
| ### 3. Enter Admin Personal Access Token (First time only) | ||||||
|
|
||||||
| If this is the first time you are signing up with your instance, we need an | ||||||
| admin access token for setting up the CodeRabbit. | ||||||
|
|
@@ -50,19 +50,23 @@ the token, please follow the process outlined below: | |||||
| 9. Select Create personal access token. | ||||||
| 10. Please note down this token as this will be visible one time only | ||||||
|
|
||||||
|  | ||||||
|
|
||||||
| ### 4. Paste the Token and Submit | ||||||
|
|
||||||
| - Submit the access token. | ||||||
| - We will handle the setup process for you. | ||||||
|
|
||||||
|  | ||||||
| :::note | ||||||
| For future visits, your setup will be automatically recognized, enabling seamless login. | ||||||
| ::: | ||||||
|
|
||||||
| ### 5. Whitelist CodeRabbit IP Address | ||||||
|
|
||||||
| Use this CodeRabbit IP if your instance requires IP whitelisting | ||||||
| `35.222.179.152/32` | ||||||
|
|
||||||
| :::tip | ||||||
| Refer to our [Get Started Guide](../get-started/add-repo.md) to make the most of CodeRabbit. | ||||||
| ::: | ||||||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Tip
Codebase Verification
The verification process confirms that the link to the Jira Integration documentation is incorrect or outdated, as indicated by the 404 HTTP status code received when attempting to access the link. This supports the review comment's suggestion to verify the link's correctness and ensure it leads to the intended section.
Analysis chain
The section on finding related issues is insightful. However, the link to the Jira Integration documentation might be incorrect or outdated, as indicated by previous comments. Verify the link's correctness and ensure it leads to the intended section.
Scripts Executed
The following scripts were executed for the analysis:
Script:
Length of output: 119
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
are reviews working ?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@guritfaq, yes, the review process is operational and continuously being enhanced to support new features and integrations, including those with Jira, Linear, and Self-Managed GitLab as detailed in the PR. These updates are part of our commitment to streamline project management processes and maintain high code quality standards. If you have specific concerns or features you're curious about, feel free to ask!