Skip to main content

CodeCov

Scorecards

Summary

Codecov monitors code coverage in your application. You can use Codecov to drive insights into values such as:

  • Code coverage

Setup

In order to connect Cortex to your Codecov instance, you’ll need to create a Codecov API token, and add it under Settings → Codecov.

caution

If you do not see the Settings page you're looking for in the sidebar, you likely don't have the proper permissions and need to contact your admin.

Registration

Discovery

By default, Cortex will use the git repository (e.g. GitHub repo) as the "best guess" for the corresponding Codecov project, since Codecov projects are connected to repositories. For example, if the GitHub repo is my-org/repo, then the project in Codecov should also be associated with my-org/repo.

If the Codecov project you want to associate isn't the same as the repository, you can override this in the Cortex entity descriptor.

Entity descriptor

If you need to override the automatic discovery, you can define the following block in your Cortex entity descriptor.

x-cortex-static-analysis:
codecov:
owner: org-name # git org
repo: my-project # git repo name without the org
provider: AZURE_DEVOPS | BITBUCKET | BITBUCKET_SERVER | GITHUB | GITHUB_ENTERPRISE | GITLAB | GITLAB_ENTERPRISE # select one of the options
flag: flag # pulls from isolated & categorized coverage reports (optional)

The value for repo should be the full repository since Codecov maps projects by the git repo.