Skip to content
This repository was archived by the owner on Aug 16, 2025. It is now read-only.
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
Update docs on issue integration
  • Loading branch information
karan925 committed Jan 22, 2025
commit 3d7e292e67714575ec714488d04e67bebcad851c
37 changes: 37 additions & 0 deletions docs/integrations/issue-integrations.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,17 @@ Upon enabling the Jira integration, CodeRabbit will redirect you to the Jira log

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

### Example Usage

Inside your pull request, you can include a issue to for CodeRabbit to perform an assessment and validate if the code satisfies the requirements of the issue.

To link a Jira Issue, you can add the Jira Issue into the PR description.

```text
// (Jira Project Key - Issue Number)
Closes CR-5
```

## Linear {#Linear}

```mdx-code-block
Expand All @@ -44,3 +55,29 @@ Upon enabling the Linear integration, CodeRabbit will redirect you to the Linear
1. Add Linear's Team Keys to the `knowledge_base.linear.team_keys` field in your project's CodeRabbit configuration file at `.coderabbit.yaml`.

[integrations]: https://app.coderabbit.ai/integrations

### Example Usage

To link a Linear Issue, you can add the Linear Issue via team key and issue number into the PR description.

```text
// (Linear Team Key - Issue Number)
Closes ENG-123
```

## GitHub

```mdx-code-block
<ProPlanNotice />
```

GitHub issue integration works automatically without any additional setup required.

### Example Usage

To link a GitHub Issue, you can add the issue into the PR description.

```text
// (# GitHub Issue Number)
Closes #123
```