Skip to main content

External Knowledge Base

CodeRabbit integrates with external knowledge bases to provide a seamless experience for issue tracking. This will allow CodeRabbit to use the context from the linked issues while reviewing the code.

Jira​

CodeRabbit App​

  1. Navigate to integrations in the CodeRabbit app.
  2. Toggle the Jira switch to enable the integration.

Upon enabling the Jira integration, CodeRabbit will redirect you to the Jira login page. Enter your Jira credentials to authenticate the integration.

CodeRabbit Configuration​

  1. Add Jira's Project Keys to the knowledge_base.jira.project_keys field in your project's CodeRabbit configuration file at .coderabbit.yaml.

Creating Issues with Jira Integration​

  1. If you had already enabled Jira integration, you will need to disable and re-enable it in order to get the newly updated required permissions.
  2. This feature will use the first project key found in the repository settings from knowledge_base.jira.project_keys field.

CodeRabbit is able to create issues from a PR comment if the message is clear that you want to create a new jira issue.

Example: Create a new jira issue to remind me about this refactor.

Linear​

CodeRabbit App​

  1. Navigate to integrations in the CodeRabbit app.
  2. Toggle the Linear switch to enable the integration.

Upon enabling the Linear integration, CodeRabbit will redirect you to the Linear login page. Enter your Linear credentials to authenticate the integration.

CodeRabbit Configuration​

  1. Add Linear's Team Keys to the knowledge_base.linear.team_keys field in your project's CodeRabbit configuration file at .coderabbit.yaml.