This content is part of a third party extension that is not supported by the Cake project.
For more information about this extension see Cake.Codecov.
Summary
Contains settings used by
CodecovRunner for the new Codecov Uploader provided
by their team.
- 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 : ToolSettingsConstructors
| 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.
|
| CleanReports | bool |
Gets or sets a value indicating whether Discovered coverage reports should be moved to
the trash.
|
| Commit | string |
Gets or sets a property specifing the commit sha.
|
| DryRun | bool |
Gets or sets a value indicating whether files should be uploaded to Codecov.
|
| EnableGcovSupport | bool |
Gets or sets a value indicating whether Codecov should run with gcov support or not.
|
| Envs | IEnumerable |
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 |
Gets or sets a value specifying which flags should be toggled on/off.
|
| Files | IEnumerable |
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.
|
| NonZero | bool |
Gets or sets a value indicating whether Codecov should exit with a non-zero exit code on errors.
|
| ParentSha | string |
Gets or sets the commit SHA of the parent for which you are uploading coverage. If not
set, the parent will be determined using the API of your repository provider. When using
the repository provider's API, the parent is determined via finding the closest ancestor
of the commit.
|
| Pr | string |
Gets or sets a value specifing the pull request number.
|
| RootDirectory | DirectoryPath |
Gets or sets the root directory when it is not a git repository.
|
| SearchDirectory | DirectoryPath |
Gets or sets the directory to use when searching for coverage reports.
|
| ShowChangelog | bool |
Gets or sets a value indicating whether the a link should be displayed to the current changelog.
|
| 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 |
string |
Get a basic string representation of specified object.
From LoggingExtensions
Requires the Cake.Incubator addin
|
| IsIn |
bool |
Checks if the source is contained in a list
From EnumerableExtensions
Requires the Cake.Incubator addin
|
| NotNull |
void |
Throws an exception if the specified parameter's value is null.
From Extensions
Requires the Cake.Ftp addin
|
| NotNull |
void |
Throws an exception if the specified parameter's value is null.
From IssuesArgumentChecks
Requires the Cake.Issues addin
|
| ThrowIfNull |
T |
Throws a
System.ArgumentNullException with a specific message if the value is null, otherwise returns the value
From AssertExtensions
Requires the Cake.Incubator addin
|
| ThrowIfNull |
T |
Throws a
System.ArgumentNullException if the value is null, otherwise returns the value
From AssertExtensions
Requires the Cake.Incubator addin
|
| ToDictionary |
IDictionary |
From ObjectHelpers
Requires the Cake.DeployParams addin
|
| To |
string |
Returns the string value or a
Not set> markup suitable for Spectre.Console.
From StringExtensions
Requires the Cake.Issues addin
|