Interface Options

The api url used to fetch the upload url.

Only required if self-hosting codecov.

Example: apiUrl: 'https://api.codecov.io'

Defaults to https://api.codecov.io.

The name for the bundle being built.

Required for uploading bundle analysis information.

The name must match the pattern /^[\w\d_:/@\.{}\[\]$-]+$/.

Example: bundleName: '@codecov/rollup-plugin'

Option to enable debug logs for the plugin.

When enabled information will not be uploaded to Codecov.

Example: dryRun: true

Defaults to false

Whether you would like bundle analysis to be enabled. *

Example: enableBundleAnalysis: true

Defaults to false

Override value for git service used for tokenless uploads. Using tokenless uploads is only supported for public repositories.

Note: If an uploadToken is provided you do not need to provide a gitService.

The value must be one of the following:

• github
• gitlab
• bitbucket
• github_enterprise
• gitlab_enterprise
• bitbucket_server

Example gitService: 'github'

Options for OIDC authentication.

The amount of times the upload function will retry to upload bundle analysis information.

Defaults to 3

When enabled telemetry data will be sent to Codecov.

Example: telemetry: false

Defaults to true

Override values for passing custom information to API.

The upload token to use for uploading the bundle analysis information.

This field is required for uploading bundle analysis information in private repositories. Alternatively if you're using GitHub Actions and have configured OIDC authentication you can omit this field, and enable the oidc.useGitHubOIDC option.

This value can either be a global upload token or a repo token.

• The global upload token can be found under the organization settings page.
• The repo token can be found under the repo settings page under the general tab.