Skip to content

Update issue integrations #207

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jan 22, 2025
Merged
Changes from all commits
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
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

You can link an issue to your pull request, allowing CodeRabbit to assess whether your changes satisfy the issue's requirements.

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

```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 the team key and issue number into the PR description as shown below.

```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 as shown below.

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