CodecovSettings Class

Summary

Contains settings used by CodecovRunner. See CommandLineOptions or run. 
.\codecov.exe --help
for more details.
Assembly
Cake.Codecov.dll
Namespace
Cake.Codecov
Base Types
  • ToolSettings
graph BT Type-->Base0["ToolSettings"] Type["CodecovSettings"] class Type type-node

Syntax

public sealed class CodecovSettings : ToolSettings

Constructors

Name Summary
CodecovSettings()

Properties

Name Value Summary
Branch string
Gets or sets a property specifing the branch name.
Build string
Gets or sets a property specifing the build number.
Commit string
Gets or sets a property specifing the commit sha.
DisableNetwork bool
Gets or sets a value indicating whether to toggle functionalities. (1) --disable-network. Disable uploading the file network.
Dump bool
Gets or sets a value indicating whether to don't upload and dump to stdin.
Envs IEnumerable<string>
Gets or sets a value specifing the enviornment variables to be included with this build. (1) CODECOV_ENV=VAR1,VAR2. (2) -e VAR1 VAR2.
Features IEnumerable<string>
Gets or sets a value specifying which flags should be toggled on/off.
Files IEnumerable<string>
Gets or sets a value specifing the target file(s) to upload. (1) -f 'path/to/file'. Only upload this file. (2) -f 'path/to/file1 path/to/file2'. Only upload these files.
Flags string
Gets or sets a value specifing the flag the upload to group coverage metrics. (1) --flag unittests. This upload is only unittests. (2) --flag integration. This upload is only integration tests. (3) --flag ut,chrome. This upload is chrome - UI tests.
Name string
Gets or sets a value specifing the custom defined name of the upload. Visible in Codecov UI.
NoColor bool
Gets or sets a value indicating whether to remove color from the output.
Pr string
Gets or sets a value specifing the pull request number.
Required bool
Gets or sets a value indicating whether to exit with 1 if not successful. Default will Exit with 0.
Root DirectoryPath
Gets or sets a value used when not in git project to identify project root directory.
Slug string
Gets or sets a value specifing the owner/repo slug used instead of the private repo token in Enterprise. (option) Set environment variable CODECOV_SLUG=:owner/:repo.
Tag string
Gets or sets a value specifing the git tag.
Token string
Gets or sets a value specifing the private repository token. (option) set the enviornment variable CODECOV_TOKEN-uuid. (1) -t @/path/to/token_file. (2) -t uuid.
Url Uri
Gets or sets a value specifing the target url for Enterprise customers. (option) Set environment variable CODECOV_URL=https://my-hosted-codecov.com.
Verbose bool
Gets or sets a value indicating whether to run in verbose mode.

Extension Methods

Name Value Summary
Dump<CodecovSettings>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
IsIn<CodecovSettings>(CodecovSettings[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<CodecovSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
NotNull<CodecovSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Issues addin
ThrowIfNull<CodecovSettings>(string, string) T
Throws a System.ArgumentNullException with a specific message if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ThrowIfNull<CodecovSettings>(string) T
Throws a System.ArgumentNullException if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ToDictionary() IDictionary<string, object>
Requires the Cake.DeployParams addin