[Video Guide] Connecting Codecov to Github

For Github users looking to connect Codecov to their Github account

For Codecov to fully function with Github, there are two layers of connection needed:

1. A CONNECTED, INDIVIDUAL ACCOUNT ON AN APPROVED GITHUB ORGANIZATION:

Codecov uses the GitHub OAuth Application flow to authenticate users when they login to Codecov using GitHub.

For Codecov to be able to publish comments on the pull request as well as decorate your code with coverage data, the minimum user level access in Github is "write access."

2. A DEDICATED CONNECTION POINT BETWEEN YOUR GITHUB ORGANIZATION AND CODECOV

There are two options for Organization Level connection:

a.) (Recommended) The Github App connection, which connects between your Github Organization and the Codecov App on Github, found here: https://github.com/apps/codecov
OR
B.) Using a Team Bot with Oauth access (e.g., user-level connection).

This video guide demonstrates step 1: User-level connection

Step 1: Account Creation

Step 2: Admin Access

If you are signing up via GitHub, you may need to request access from an admin to authorize Codecov as a third-party application. An admin can approve this request in the "Third-party access" tab in the organization's settings page:

https://github.com/organizations/[YOUR_ORG_NAME]/settings/oauth_application_policy.

For more information and screenshots on this process, please visit GitHub OAuth Admin Authorization

Here is what your Github Administrator will see to enable you

Step 3: Granting Private Scope

If you are using Codecov with one or more private repos, you will also need to grant Codecov Private scope.


Did this page help you?