ReportIssuesToPullRequestFromIssueProviderSettings Class

Summary

Settings affecting how issues read from issue provider are reported to pull requests.
Assembly
Cake.Issues.PullRequests.dll
Namespace
Cake.Issues.PullRequests
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["IReportIssuesToPullRequestFromIssueProviderSettings"] click Interface0 "/api/Cake.Issues.PullRequests/IReportIssuesToPullRequestFromIssueProviderSettings" Type-.->Interface1["IReadIssuesSettings"] click Interface1 "/api/Cake.Issues/IReadIssuesSettings" Type-.->Interface2["IReportIssuesToPullRequestSettings"] click Interface2 "/api/Cake.Issues.PullRequests/IReportIssuesToPullRequestSettings" Type-.->Interface3["IRepositorySettings"] click Interface3 "/api/Cake.Issues/IRepositorySettings" Type["ReportIssuesToPullRequestFromIssueProviderSettings"] class Type type-node

Syntax

public class ReportIssuesToPullRequestFromIssueProviderSettings : ReadIssuesSettings, 
    IReportIssuesToPullRequestFromIssueProviderSettings, IReadIssuesSettings, 
    IReportIssuesToPullRequestSettings, IRepositorySettings

Constructors

Name Summary
ReportIssuesToPullRequestFromIssueProviderSettings(DirectoryPath) Settings affecting how issues read from issue provider are reported to pull requests.

Properties

Name Value Summary
CommentSource string
Gets or sets a value used to decorate comments created by this add-in. Only comments with the same source will be resolved.
CommitId string
Gets or sets the hash of the commit for which the issues were reported.
FileLinkSettings FileLinkSettings
Gets or sets settings which can be used for resolving links to source files.
Inherited from ReadIssuesSettings
IssueFilters IList<Func<IEnumerable<IIssue>, IEnumerable<IIssue>>>
Gets list of filter functions which should be applied before posting issues to pull requests.
MaxIssuesToPost Nullable<int>
Gets or sets the global number of issues which should be posted at maximum over all IIssueProvider. Issues are filtered by Priority and issues with an AffectedFileRelativePath are prioritized. Default is null which won't set a global limit. Use MaxIssuesToPostAcrossRuns to set a limit across multiple runs.
MaxIssuesToPostAcrossRuns Nullable<int>
Gets or sets the global number of issues which should be posted at maximum over all IIssueProvider and across multiple runs. Issues are filtered by Priority and issues with an AffectedFileRelativePath are prioritized. Default is null which won't set a limit across multiple runs. Use MaxIssuesToPost to set a limit for a single run.
MaxIssuesToPostForEachIssueProvider Nullable<int>
Gets or sets the number of issues which should be posted at maximum for each IIssueProvider. Issues are filtered by Priority and issues with an AffectedFileRelativePath are prioritized. null won't limit issues per issue provider. Default is to filter to 100 issues for each issue provider. Use ProviderIssueLimits to set limits for individual issue providers.
ProviderIssueLimits Dictionary<string, IProviderIssueLimits>
Gets the issue limits for individual IIssueProvider. The key must be the ProviderType of a specific provider to which the limits should be applied to. Use MaxIssuesToPostForEachIssueProvider to set the same limit to all issue providers.
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<ReportIssuesToPullRequestFromIssueProviderSettings>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
IsIn<ReportIssuesToPullRequestFromIssueProviderSettings>(ReportIssuesToPullRequestFromIssueProviderSettings[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<ReportIssuesToPullRequestFromIssueProviderSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
NotNull<ReportIssuesToPullRequestFromIssueProviderSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Issues addin
ThrowIfNull<ReportIssuesToPullRequestFromIssueProviderSettings>(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<ReportIssuesToPullRequestFromIssueProviderSettings>(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
ToStringWithNullMarkup() string
Returns the string value or a Not set> markup suitable for Spectre.Console.
Requires the Cake.Issues addin