Skip to content

Automated PR Review

Use this guide to learn how to configure CloudAEye so that code reviews begin automatically whenever a pull request is opened.

Overview

CloudAEye initiates a code review of a PR when a user comments @cloudaeye /review on the PR. You can configure CloudAEye to review every new PR when it is first opened.

Prerequisites

Step 1: Register

Sign up with CloudAEye SaaS.

Step 2: Setup Code Review

Setup Code Review by following the Getting Started guide.

Configure Auto Review

CloudAEye allows you to configure Auto Review at two levels:

  • Repository-level configuration: Enable and customize Auto Review for individual repositories.
  • Global configuration: Enable Auto Review by default and select the review type from the Settings page.

1. Configure Auto Review for a GitHub Repository

You can configure Auto Review separately for each repository from the GitHub Repositories page.

  1. In the Code Review dashboard, navigate to Integrations from the left navigation. Go to Home > Code Review > Integrations.
  2. Under GitHub, click Repos to open the GitHub Repositories page.
  3. Locate the repository you want to configure and click the icon in the Settings column.
  4. You will see a new screen with Auto Review tab. On the configuration page, select the Enable Auto Review checkbox.
  5. Select the desired Auto Review Type:
    • Inspect: Performs an essential review to identify key issues in the code changes.
    • Review: Performs an in-depth review to analyze code changes more thoroughly.
  6. Optionally, configure filters to narrow down which pull requests are eligible for automatic review. See the Auto Review Filters section below.
  7. Click Save to apply your changes.

Enable Auto Review

Repeat these steps for each repository that requires a different Auto Review configuration.

2. Configure Auto Review Globally

You can also configure Auto Review globally from the Settings page.

  1. Navigate to Home > Code Review > Settings > Auto Review. You will see the Auto Review tab under Settings page.
  2. Select the Enable Auto Review checkbox.
  3. Select the desired review type from the dropdown menu:
    • Inspect: Performs an essential review, focusing on identifying key issues.
    • Review: Performs a more in-depth analysis of code changes.
  4. Save your changes.

Enable Auto Review Globally

The global configuration provides a central place to manage Auto Review settings. Use the repository-level configuration when you need to customize Auto Review for individual repositories.

Auto Review Filters

Repository-level Auto Review supports filters that help you control which pull requests are automatically reviewed. Configure these filters to narrow the scope of automatic reviews based on your team's requirements.

Use filters when you want Auto Review to run only on pull requests that match specific criteria.

Filter Types

You can configure CloudAEye to only review PRs that match certain filters.

Filter Description
Labels Filter by pull request labels
Branches Filter by source branches
Author Filter by pull request author
Keywords Filter by keywords in the title, description, or most recent commit message

You can include or exclude pull requests based on labels, branches, authors, or keywords to control which pull requests are eligible for automatic code review.

Use these filters to focus reviews on specific workflows, prioritize important changes, or avoid reviewing pull requests that do not require automated analysis.

1. Labels

Include or exclude pull requests based on their GitHub labels.

Use this filter to target pull requests with specific labels or skip reviews for pull requests that do not require them.

Example: Include pull requests labeled ready-for-review.

Use case: Your team uses labels to manage the pull request lifecycle. You can configure Auto Review to run only when a developer or reviewer adds the ready-for-review label, ensuring that automated reviews start when a pull request is ready.

2. Branches

Include or exclude pull requests based on their source branch names. Branch matching is case-sensitive.

Use this filter to enable or restrict automatic reviews for specific development or release branches.

Example: Include pull requests from the main branch.

Use case: Your team wants every change proposed for production to receive an automated review, while allowing less formal reviews for feature branches. Configure Auto Review to include the main branch so that pull requests from it are reviewed automatically.

Note:

  • Branch names are case-sensitive. For example, main and Main are treated as different branch names.
  • The target branch should match the branch you vectorized during onboarding. You can find this branch in the GitHub Repositories page under the Branch column.

author

3. Author

Include or exclude pull requests based on the GitHub handle of the pull request author. Author matching is case-sensitive.

Use this filter to control which contributors' pull requests receive automatic reviews.

Example: Include pull requests authored by alice-dev.

Use case: Your team wants automated reviews for pull requests created by a specific group of developers or by an automation account. Configure the filter with the relevant GitHub handles to target those contributors.

Note: Enter the GitHub handle, not the contributor's display name. Ensure the capitalization matches the GitHub handle exactly.

4. Keywords

Include or exclude pull requests containing specific keywords in the pull request title, description, or last commit message.

Use this filter to target pull requests based on their purpose or the type of change they introduce.

Example: Include pull requests containing the keyword security in the title, description, or last commit message.

Use case: Your team wants additional automated review attention for security-related changes. Configure the keyword filter to include security so that matching pull requests are eligible for Auto Review.