Skip to content

Latest commit

 

History

History
50 lines (29 loc) · 1.98 KB

knowledge-base.md

File metadata and controls

50 lines (29 loc) · 1.98 KB
title description sidebar_label sidebar_position
Knowledge Base
Integrate CodeRabbit with an external knowledge base for issue tracking.
Knowledge Base
4

CodeRabbit utilizes an internal knowledge base that integrates with several external services to provide a seamless review and issue management experience.

Issues

The issues knowledge base allows CodeRabbit to use the context from linked and related issues while reviewing the code.

Jira {#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.

Linear {#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.

Learnings

You can tell the bot to remember things about either specific lines in files, or generally about the entire repository, or even across repositories.

On-premises

For self-hosted / on-premises deployments, you can enabled the knowledge base features by setting ON_PREM_KNOWLEDGE_BASE to true in the environment variables for your self-hosted docker image.

By default CodeRabbit will store it's data in the coderabbitai/data branch unless you set ON_PREM_KNOWLEDGE_BASE_BRANCH with a different value.