Prerequisites
Before setting up the CircleCI integration, ensure you have:- A CircleCI account with access to the projects you want to connect
- Permission to generate Personal API Tokens in CircleCI
Connect CircleCI
The integration uses a CircleCI Personal API Token to authenticate.1
Open Connections
Open Connections and select Add connection.
2
Choose CircleCI
Select CircleCI, choose Direct connection for Review, and give the connection a recognizable name.
3
Create a Personal API Token in CircleCI
In a new browser tab:
- Go to your CircleCI User Settings.
- Click Create New Token.
- Give it a descriptive name, for example
CodeRabbit Integration. - Copy the generated token.
4
Paste the token into CodeRabbit
Back in CodeRabbit, paste the token into the API Token field and select Save.
5
Add the connection to the Review Base Scope
If you did not add the connection to the Review Base Scope during setup, open Review scopes and select it there.
Keep your Personal API Token secure. It grants CodeRabbit read access to your CircleCI pipeline logs. If the token is revoked or rotated, repeat the steps above to reconnect.
How it works
After connecting:- A pull request is opened or updated and your CircleCI pipelines run.
- CodeRabbit waits for the pipelines to finish.
- CodeRabbit reads the failure output via the CircleCI pipeline API.
- Inline comments with suggested fixes are posted on the relevant lines of code.
What’s next
CI/CD pipeline analysis
Learn how CodeRabbit analyzes pipeline failures across all supported CI/CD platforms and posts fix suggestions inline.
GitHub Checks configuration
Configure the timeout and enable/disable behavior for GitHub Actions pipeline analysis.