@zuke/codecov

`@zuke/codecov` — a typed Codecov CLI (`codecovcli`) task wrapper for Zuke

Symbols

# CodecovTasks const

const CodecovTasks: CodecovTasksApi

Typed task functions for the Codecov CLI.

# CodecovTasksApi interface

interface CodecovTasksApi

The shape of CodecovTasks.

Member	Signature	Doc
`upload`	`upload(configure?: Configure<CodecovUploadSettings>): Promise<CommandOutput>`	Upload coverage reports: `codecovcli upload-process`.

# CodecovUploadSettings class

class CodecovUploadSettings extends ToolSettings

Settings for codecovcli upload-process.

Member	Signature	Doc
`files`	`files(...paths: string[]): this`	A coverage report file to upload (`--file`). Repeatable.
`flags`	`flags(...names: string[]): this`	Tag the uploaded reports with a flag (`--flag`). Repeatable.
`plugins`	`plugins(...names: string[]): this`	Run an upload plugin, e.g. `gcov` or `noop` (`--plugin`). Repeatable.
`token`	`token(value: string): this`	Repository upload token (`--token`); prefer the `CODECOV_TOKEN` env var.
`slug`	`slug(value: string): this`	Repository slug as `OWNER/REPO` (`--slug`).
`sha`	`sha(value: string): this`	Commit SHA the coverage belongs to (`--sha`).
`branch`	`branch(value: string): this`	Branch the coverage belongs to (`--branch`).
`pullRequest`	`pullRequest(value: string \| number): this`	Pull request number the coverage belongs to (`--pr`).
`gitService`	`gitService(value: string): this`	Git host the repo lives on, e.g. `github` (`--git-service`).
`name`	`name(value: string): this`	A custom display name for this upload (`--name`).
`dir`	`dir(value: string): this`	Directory to search for coverage reports (`--dir`).
`networkRootFolder`	`networkRootFolder(value: string): this`	Root folder used to resolve report file paths (`--network-root-folder`).
`reportType`	`reportType(value: string): this`	Report kind: `coverage` (default) or `test_results` (`--report-type`).
`disableSearch`	`disableSearch(): this`	Upload only the named files, skipping the auto-search (`--disable-search`).
`handleNoReportsFound`	`handleNoReportsFound(): this`	Succeed instead of erroring when no reports are found (`--handle-no-reports-found`).
`failOnError`	`failOnError(): this`	Exit non-zero when the upload fails (`--fail-on-error`).
`dryRun`	`dryRun(): this`	Print what would be uploaded without sending anything (`--dry-run`).