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

Team Bot

Choose a user account that will consume GitHub/Bitbucket/GitLab API in Codecov's build jobs.

GitHub Integrations

The best way to integrate with Codecov is to Install Codecov's GitHub Integration.

Once installed, you are done! You do not need to set a Team Bot because Codecov will use the integration to post statuses and comments.

Codecov will use a single user's OAuth token to interact with your repositories, using GitHub/Bitbucket/GitLab API's. We call this the Codecov Bot.

Please follow these steps to select a Codecov Bot.

  1. Choose an existing user account, or create a new bot account.
  2. Login with this account into Codecov.
    • Grant private repository access for GitHub users.
  3. Set the bot in the Team Yaml by navigating to /account/gh/OWNER/yaml.
  4. Type in the new username in the yaml as seen below.
  5. Click Save.
  6. Run a CI and upload coverage to Codecov to confirm that the new setup works.
codecov:
  bot: your-bot-username

Frequently asked questions

Do I need to login with the bot account first?

Yes. Codecov needs to get the bot's account OAuth token and link the user to your team. It is very important to give the bot private repository access for GitHub customers.

Do I change the Team Yaml from the bot account?

No. Only Codecov Administrators and GitHub/GitLab/Bitbucket Team Administrators can adjust the Team Yaml.