Add CodeRabbit to your repository
This page presents an overview of integrating CodeRabbit with your Git platform. For a conceptual overview of CodeRabbit, see Introduction.
Use CodeRabbit with Git platforms
CodeRabbit integrates with the following Git platforms:
The exact steps for each platform are outlined in the pages linked above. That said, integrating any Git platform with CodeRabbit follows this general pattern:
-
Log into CodeRabbit using your Git platform account.
-
Add the organizations containing the repositories that you want CodeRabbit to work with. You generally need ownership-level permissions with these organizations. (Different Git platforms might call their organizations different things, such as "groups" in GitLab and "workspaces" in BitBucket.)
-
Create a dedicated CodeRabbit service account on your Git platform, if needed. We handle this step for you on some platforms, such as GitHub.com.
-
Grant CodeRabbit the permissions that it needs to work with one or more of the repositories that you have ownership-level access to.
After you finish integrating CodeRabbit with one or more repositories, you can start using CodeRabbit immediately using its default configuration, which automatically reviews or summarizes new pull requests. You can also customize CodeRabbit’s configuration to suit your team's needs.