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

Detecting CI Services

Codecov automatically detects a wide variety of CI providers. There are some exceptions, or new providers, that Codecov does not detect. In the event that your CI provider does not meet our matching criteria, you would need to provide the domain where your provider is located at.

You can also ignore detecting the status of a specific CI provider. Below, we are ignoring AppVeyor. This is useful when, for example, you have not properly configured AppVeyor, or you are not expecting coverage reports uploaded from a CI provider.

codecov:
  ci:
    - jenkins.domain.com       # add my custom jenkins server
    - !appveyor                # ignore CI builds by AppVeyor
    - !not.this.domain.com     # ignore this domain

Detection Technique

Codecov detects CI services through the Commit Status API provided by GitHub/Bitbucket/GitLab. We review the target url, and context, in order to determine if the status is a "continuous integration service" that uploads coverage reports.

There is a match when ci, semaphoreci, pull request validator (cloudbees), continuous-integration, or buildkite is found in the context.