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.Coveralls.

Summary

Contains settings used by CoverallsNetRunner.

Assembly

Cake.Coveralls.dll

Namespace

Cake.Coveralls

Base Types

ToolSettings

graph BT Type-->Base0["ToolSettings"] Type["CoverallsNetSettings"] class Type type-node

Syntax

public sealed class CoverallsNetSettings : ToolSettings

Constructors

Name	Summary
CoverallsNetSettings()

Properties

Name	Value	Summary
BaseFilePath	DirectoryPath	Gets or sets the Base File path, which when UseRelativePaths is set, this path is used instead of the current working directory.
CommitAuthor	string	Gets or sets the git commit author for coverage report.
CommitBranch	string	Gets or sets the git commit branch for coverage report.
CommitEmail	string	Gets or sets the git commit email for coverage report.
CommitId	string	Gets or sets the git commit hash for coverage report.
CommitMessage	string	Gets or sets the git commit message for coverage report.
JobId	string	Gets or sets the Job Id to provide to coveralls.io.
OutputFilePath	FilePath	Gets or sets the Output File path.
RepoToken	string	Gets or sets the Repo Token to use when publishing to Coveralls.io.
RepoTokenVariable	string	Gets or sets the Repo Token Variable which is the Environment Variable name where the coverall.io token is available.
ServiceName	string	Gets or sets the service name for the coverage report.
TreatUploadErrorsAsWarnings	bool	Gets or sets a value indicating whether to exit successfully if an upload error is encountered.
UseRelativePaths	bool	Gets or sets a value indicating whether to attempt to strip the current working directory from the beginning of the source file path.

Extension Methods

Name	Value	Summary
Dump<CoverallsNetSettings>()	string	Get a basic string representation of specified object. From LoggingExtensions Requires the Cake.Incubator addin
IsIn<CoverallsNetSettings>(CoverallsNetSettings[])	bool	Checks if the source is contained in a list From EnumerableExtensions Requires the Cake.Incubator addin
NotNull<CoverallsNetSettings>(string)	void	Throws an exception if the specified parameter's value is null. From IssuesArgumentChecks Requires the Cake.Issues addin
NotNull<CoverallsNetSettings>(string)	void	Throws an exception if the specified parameter's value is null. From Extensions Requires the Cake.Ftp addin
ThrowIfNull<CoverallsNetSettings>(string, string)	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<CoverallsNetSettings>(string)	T	Throws a `System.ArgumentNullException` if the value is null, otherwise returns the value From AssertExtensions Requires the Cake.Incubator addin
ToDictionary()	IDictionary<string, object>	From ObjectHelpers Requires the Cake.DeployParams addin
ToStringWithNullMarkup()	string	Returns the string value or a `Not set`> markup suitable for Spectre.Console. From StringExtensions Requires the Cake.Issues addin

CoverallsNetSettings Class

Summary

Syntax

Constructors

Properties

Extension Methods