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.PullRequests.
Summary
Interface for settings affecting how issues are reported to pull requests.
- Assembly
- Cake
.Issues .PullRequests .dll - Namespace
- Cake
.Issues .PullRequests - Interfaces
- Implementing Types
graph BT
Type-.->Interface0["IRepositorySettings"]
click Interface0 "/api/Cake.Issues/IRepositorySettings"
Type["IReportIssuesToPullRequestSettings"]
class Type type-node
Implementing0["ReportIssuesToPullRequestFromIssueProviderSettings"]-.->Type
click Implementing0 "/api/Cake.Issues.PullRequests/ReportIssuesToPullRequestFromIssueProviderSettings"
Implementing1["ReportIssuesToPullRequestSettings"]-.->Type
click Implementing1 "/api/Cake.Issues.PullRequests/ReportIssuesToPullRequestSettings"
Implementing2["IReportIssuesToPullRequestFromIssueProviderSettings"]-.->Type
click Implementing2 "/api/Cake.Issues.PullRequests/IReportIssuesToPullRequestFromIssueProviderSettings"
Syntax
public interface IReportIssuesToPullRequestSettings : IRepositorySettingsProperties
| 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.
|
| IssueFilters | IList |
Gets list of filter functions which should be applied before posting issues to pull requests.
|
| MaxIssuesToPost | Nullable |
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.
|
| Max |
Nullable |
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.
|
| Max |
Nullable |
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 |
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.
|
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
|