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

Frequently Asked Questions

Where is the repository upload token found?

The unique repository upload token is found on the settings page of your project. https://codecov.io/gh/<owner>/<repo>/settings. You need write access to view this token.

The upload token is required for all uploads, except originating from public project using Travis-CI, Circle CI, or AppVeyor CI.

How do I add new users to my repository?

Codecov uses GitHub/Bitbucket/GitLab API's to authorize users. No setup is necessary. As long as a user has read access to your project, they can view coverage details on Codecov.

What commit does Codecov use to compare against?

Please see Comparing Commits .

How do I change the user that posts pull request comments?

Please see Team Bot .

Why are my commit messages and user avatars missing?

Please see Team Bot.

Does Codecov merge reports for multiple containers and/or CI providers?

Yes. See Merging Reports.

Can we group reports based on the type of tests?

Yes. See Flags.

Is there an on-premise version of Codecov?

Yes. Please visit https://codecov.io/enterprise to inquire.
Enterprise: Frequently Asked Questions

Can I fail the CI build if coverage drops?

No. We use Commit Statuses too, and do not fail builds.

How does Codecov run the tests?

It does not run CI. Learn more.

Where are my other branches?

Codecov only shows branches and commits when content is uploaded to these resources. We are planning to show all resources and become more synchronous with your repository.

All pull requests sync up: merged, open, and closed. Our first step in to sync all references.

How does Codecov interact with my source code?

Please read https://codecov.io/site/security#does-codecov-store-source-code

How is coverage calculated?

Each language may calculate coverage differently, but for the sake of consistency Codecov will calculate coverage percentage as:

round((hits / (hits + partials + misses)) * 100, 5) = Coverage Ratio

Note: Partials are considered a full miss, regardless of the number of branches hit or missed.

Where are all my commits/branches/pulls?

Codecov only shows commits that have uploaded coverage reports. Therefore, when you link a new project Codecov will be empty, with no content.

  • Branches will show up when a commit is uploaded on that branch.
  • Pull requests are synced, regardless of having a coverage report uploaded. The sync will occur upon the first pull request webhook sent from GitHub to Codecov.

Frequently Asked Questions