Github App or Team Bot

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


GitHub User? Install Codecov's GitHub App!

Integrating with Codecov is easy using Codecov's GitHub App.

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 Bitbucket or 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 (this would be a username for Gitlab or Bitbucket).
  • This account MUST have admin access in order to send webhooks and create comments.
  1. First, Login with this account into Codecov. so we have a token for it.
  2. Set the bot in the Team Yaml by navigating to /account/<PROVIDER>/<ORG>/yaml.
  3. Type in the new username in the yaml as seen below.
  4. Click Save.
  5. Run a CI and upload coverage to Codecov to confirm that the new setup works.

# The user that you will use to serve as the bot connection to Codecov
# This bot user must have permissions on the repo and Codecov (by logging in)

  bot: <bot-username> #this is a username for Github/Gitlab/Bitbucket

Team Bot FAQ

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.

Do I change the Global Yaml while logged in from the bot account?

No. Only Codecov Administrators and GitLab/Bitbucket Team Administrators can adjust the Global YAML on the settings page of your organization.