Codecov

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

Browser Extension

Overlay reports directly in Github and Bitbucket

Install

Chrome Firefox Opera Safari IE
chrome firefox opera safari ie
Install Install Install planned planned

Usage

Once installed, the browser extension will work immediately, with no additional setup required. To confirm that the extension is working, please navigate to this sample link where you should see the source code highlighted, and a button added to the file header.

Overlay Locations

**Tree Navigation**  Column for file coverage, with background and commit header overall coverage.

Tree Navigation Column for file coverage, with background and commit header overall coverage.

**Source Code** adding inline background colors to source and toggle button, in the file header. Toggle by clicking the `c` key.

Source Code adding inline background colors to source and toggle button, in the file header. Toggle by clicking the c key.

**List Commits** adding coverage of the commit next to the build status.

List Commits adding coverage of the commit next to the build status.

**Compare and Pull Request** add coverage and diff to (a) file list, (b) compare header, (c) file header. Highlight gutter background with coverage metrics.

Compare and Pull Request add coverage and diff to (a) file list, (b) compare header, (c) file header. Highlight gutter background with coverage metrics.

Frequently Asked Questions

Private Repositories

Please make sure you are logged into Codecov in the browser that you are using the extension with. Otherwise, coverage will not show up.

Why is coverage not found?

Coverage will automatically overlay on commits that have reports uploaded to Codecov. If you view coverage on master branch, for example, the extension will query Codecov for the tip of master which may not be uploaded to Codecov, resulting in No Coverage* found.

           v Commit in Codecov with coverage
master . . • . .
               ^ Tip of master (no reports uploaded)

This example shows that if you view coverage on master branch it will use the latest commit on the branch which does not contain coverage reports.

Add Codecov Enterprise Endpoints

Adding your Codecov Enterprise endpoint to the browser extension is simple.

  1. Navigate to your extension manager.
  2. Find the Codecov Extension and click Configure / Preferences.
  3. Find the section titled Codecov Enterprise domains.
  4. Add the location of your Codecov Enterprise. ex. https://codecov.domain.com.
    • Your CCE must have SSL enabled, a requirement to perform CORS (Cross-Origin Requests).

Browser Extension

Overlay reports directly in Github and Bitbucket