zuke.tools.codecov
@zuke/codecov 1.1.0: @zuke/codecov — a typed Codecov CLI (codecovcli) task wrapper for Zuke builds.
zuke on PyPI ↗ 2 symbols
Symbols
class CodecovTasks Typed task functions for the Codecov CLI.
-
static async upload(ctx: ServiceContext, configure: Callable[[CodecovUploadSettings], CodecovUploadSettings] | None=None) -> ExecResultUpload coverage reports:
codecovcli upload-process.
class CodecovUploadSettings(ToolSettings) Settings for codecovcli upload-process.
-
files(*paths: str) -> SelfA coverage report file to upload (
--file). Repeatable. -
flags(*names: str) -> SelfTag the uploaded reports with a flag (
--flag). Repeatable. -
plugins(*names: str) -> SelfRun an upload plugin, e.g.
gcovornoop(--plugin). Repeatable. -
token(value: str) -> SelfRepository upload token. Routed through
CODECOV_TOKENrather than--token, because a child's argv is world-readable:psor/proc/<pid>/cmdlineshows it to every other user on the host and to every process the build starts. The environment of another process is not readable the same way, and the CLI documents the variable, so nothing is given up by preferring it. Also registered with the run's redactor, so a value that reaches the output some other way — an error message quoting a URL, a tool echoing its own configuration — is masked there too. -
slug(value: str) -> SelfRepository slug as
OWNER/REPO(--slug). -
sha(value: str) -> SelfCommit SHA the coverage belongs to (
--sha). -
branch(value: str) -> SelfBranch the coverage belongs to (
--branch). -
pull_request(value: str | float) -> SelfPull request number the coverage belongs to (
--pr). -
git_service(value: str) -> SelfGit host the repo lives on, e.g.
github(--git-service). -
name(value: str) -> SelfA custom display name for this upload (
--name). -
dir(value: str) -> SelfDirectory to search for coverage reports (
--dir). -
network_root_folder(value: str) -> SelfRoot folder used to resolve report file paths (
--network-root-folder). -
report_type(value: str) -> SelfReport kind:
coverage(default) ortest_results(--report-type). -
disable_telem() -> SelfKeep the CLI from reporting its own errors to Codecov's Sentry (
--disable-telem). A global flag, so it is emitted before the subcommand. -
disable_search() -> SelfUpload only the named files, skipping the auto-search (
--disable-search). -
handle_no_reports_found() -> SelfSucceed instead of erroring when no reports are found (
--handle-no-reports-found). -
fail_on_error() -> SelfExit non-zero when the upload fails (
--fail-on-error). -
dry_run() -> SelfPrint what would be uploaded without sending anything (
--dry-run).