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.Issues.Reporting.

Summary

Setting affecting how reports are created which are built passing issue providers.

Assembly

Cake.Issues.Reporting.dll

Namespace

Cake.Issues.Reporting

Interfaces

Base Types

graph BT Type-->Base0["ReadIssuesSettings"] click Base0 "/api/Cake.Issues/ReadIssuesSettings" Base0-->Base1["RepositorySettings"] click Base1 "/api/Cake.Issues/RepositorySettings" Base1-->Base2["Object"] Type-.->Interface0["ICreateIssueReportFromIssueProviderSettings"] click Interface0 "/api/Cake.Issues.Reporting/ICreateIssueReportFromIssueProviderSettings" Type-.->Interface1["IReadIssuesSettings"] click Interface1 "/api/Cake.Issues/IReadIssuesSettings" Type-.->Interface2["ICreateIssueReportSettings"] click Interface2 "/api/Cake.Issues.Reporting/ICreateIssueReportSettings" Type-.->Interface3["IRepositorySettings"] click Interface3 "/api/Cake.Issues/IRepositorySettings" Type["CreateIssueReportFromIssueProviderSettings"] class Type type-node

Syntax

public class CreateIssueReportFromIssueProviderSettings : ReadIssuesSettings, 
    ICreateIssueReportFromIssueProviderSettings, IReadIssuesSettings, ICreateIssueReportSettings, 
    IRepositorySettings

Constructors

Name	Summary
CreateIssueReportFromIssueProviderSettings(DirectoryPath, FilePath)	Initializes a new instance of the `CreateIssueReportFromIssueProviderSettings` class.

Properties

Name	Value	Summary
FileLinkSettings	FileLinkSettings	Gets or sets settings which can be used for resolving links to source files. Inherited from ReadIssuesSettings
OutputFilePath	FilePath	Gets the path of the generated report file.
RepositoryRoot	DirectoryPath	Gets the Root path of the repository. Inherited from RepositorySettings
Run	string	Gets or sets the name of the run. Inherited from ReadIssuesSettings

Extension Methods

Name	Value	Summary
Dump<CreateIssueReportFromIssueProviderSettings>()	string	Get a basic string representation of specified object. From LoggingExtensions Requires the Cake.Incubator addin
IsIn<CreateIssueReportFromIssueProviderSettings>(CreateIssueReportFromIssueProviderSettings[])	bool	Checks if the source is contained in a list From EnumerableExtensions Requires the Cake.Incubator addin
NotNull<CreateIssueReportFromIssueProviderSettings>(string)	void	Throws an exception if the specified parameter's value is null. From Extensions Requires the Cake.Ftp addin
NotNull<CreateIssueReportFromIssueProviderSettings>(string)	void	Throws an exception if the specified parameter's value is null. From IssuesArgumentChecks Requires the Cake.Issues addin
ThrowIfNull<CreateIssueReportFromIssueProviderSettings>(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<CreateIssueReportFromIssueProviderSettings>(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

CreateIssueReportFromIssueProviderSettings Class

Summary

Syntax

Constructors

Properties

Extension Methods