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
  • Static analysis
  • Code quality

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.

Service 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 for the service 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 with the service isn't the same as the service's repository, you can override this in the Cortex Service Descriptor.

Service Descriptor​

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

x-cortex-static-analysis:
codecov:
repo: my-project # git repo, with org and repo name
provider: GITHUB | GITLAB | BITBUCKET # select one of the three options

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