> ## Documentation Index
> Fetch the complete documentation index at: https://docs.coderabbit.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# GitHub Checks

> How CodeRabbit integrates with GitHub Checks to surface CI/CD pipeline failures and provide automated remediation suggestions on every pull request.

GitHub Checks is a CodeRabbit integration that reads the results of your GitHub Actions workflows and other CI/CD checks and incorporates them into the pull request review. When a check fails, CodeRabbit analyzes the failure logs and posts inline comments with remediation suggestions.

## How it works

When a pull request is opened or updated, CodeRabbit waits for GitHub Checks to finish and then reads their output. Any failures are analyzed and surfaced as inline review comments on the relevant lines of code, alongside suggested fixes.

This integration covers a broad range of check types including:

* Build failures (Docker, Node.js, Java, Python, Go, etc.)
* Test failures (unit, integration, end-to-end)
* Security scan findings (SAST, DAST, container scanning)
* Infrastructure-as-code validation (Terraform, Kubernetes, Ansible)
* Linter output from tools running in your CI pipeline

## Configuration

GitHub Checks integration is enabled by default. You can configure whether it is enabled using your `.coderabbit.yaml` file or the CodeRabbit web UI.

<Tabs>
  <Tab title=".coderabbit.yaml">
    ```yaml .coderabbit.yaml theme={null}
    reviews:
      tools:
        github-checks:
          enabled: true
    ```
  </Tab>

  <Tab title="Web UI">
    Go to **Reviews → Tools → GitHub Checks** in your organization or repository settings to toggle the integration on or off.

    ***
  </Tab>
</Tabs>

### Options

| Option    | Type    | Default | Description                                      |
| --------- | ------- | ------- | ------------------------------------------------ |
| `enabled` | boolean | `true`  | Enable or disable the GitHub Checks integration. |

## When CodeRabbit skips GitHub Checks

CodeRabbit skips the GitHub Checks integration when:

* `enabled` is set to `false`.
* The repository is not hosted on GitHub.
* No GitHub Checks data is available for the review.

## What's next

<CardGroup cols={1}>
  <Card title="CI/CD pipeline analysis" href="/pr-reviews/cicd-pipeline-analysis" icon="wrench" horizontal>
    Learn how CodeRabbit reads CI/CD pipeline failures and posts inline remediation suggestions across GitHub Actions, GitLab, CircleCI, and Azure DevOps.
  </Card>

  <Card title="All supported tools" href="/tools/list" icon="list" horizontal>
    Browse the complete list of linters, security analyzers, and CI/CD integrations available in CodeRabbit.
  </Card>

  <Card title="Configuration reference" href="/reference/configuration" icon="settings" horizontal>
    Full reference for all available options, including how to enable, disable, and tune individual tools.
  </Card>
</CardGroup>