Code coverage done right.®

Welcome to Codecov Documentation. You'll find comprehensive guides and documentation to help you start working with Codecov as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started

GitHub Checks (Beta)

GitHub Checks is meant to provide meaningful code coverage metrics as close to your workflow as possible. This is done by providing line-by-line coverage on your GitHub pull requests so you can access code coverage insights without leaving your code.

This feature is only available for GitHub users as it leverages GitHub Checks.

Annotations in the "Files Changed" View

Notably, lines that you add on a commit without coverage, will show up in your pull request files view with an annotation.

Added line without coverage annotated in GitHub

Hiding Annotations in the Files View

You can always hide annotations in the GitHub Files view by unselecting "Show annotations" in the top right of the file.

This GitHub feature only hides annotations by file, not for the full pull request.

Hiding Codecov Annotations in Files view

Annotations in the "Checks" Tab

To see annotations, first, go to the Checks tab under any pull request.

Look for a patch status underneath the CodecovChecks dropdown.

To view coverage information in line with your code, click on the icon to the right side of the annotation.

YAML Configuration for GitHub Checks and Codecov

GitHub Checks and annotations for the patch status are enabled by default for all GitHub users. Commit Statuses have to be enabled and set up in order for checks to be present in pull requests.

Disabling GitHub Checks Patch Annotations via YAML

Annotations can be disabled using a flag on the top-level section of the codecov.yml file.

    annotations: false

Note: If GitHub checks are disabled but statuses are still set up, normal status checks will be used instead.

Updated 2 months ago

GitHub Checks (Beta)

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.