Summary
Parameters for pull request integration.
- Assembly
- Cake
.Frosting .Issues .Recipe .dll - Namespace
- Cake
.Frosting .Issues .Recipe - Interfaces
- Base Types
-
- Object
graph BT
Type-->Base0["Object"]
Type-.->Interface0["IIssuesParametersPullRequestSystem"]
click Interface0 "/api/Cake.Frosting.Issues.Recipe/IIssuesParametersPullRequestSystem"
Type["IssuesParametersPullRequestSystem"]
class Type type-node
Syntax
public class IssuesParametersPullRequestSystem : IIssuesParametersPullRequestSystem
Constructors
Name | Summary |
---|---|
Issues |
Properties
Name | Value | Summary |
---|---|---|
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.
|
Should |
bool |
Gets or sets a value indicating whether issues should be reported to the pull request system.
Default value is
true .
|
Should |
bool |
Gets or sets a value indicating whether a status on the pull request should be set if there are any issues found.
The status is succeeded if there are no issues and fails as soon as issues from any issue provider or run have been found.
Use
ShouldSetSeparatePullRequestStatusForEachIssueProviderAndRun to report additional status for issues of every issue provider and run.
Default value is true .
|
Should |
bool |
Gets or sets a value indicating whether a separate status should be set for issues of every issue provider and run.
Use
ShouldSetPullRequestStatus to report status across all issue providers and runs.
Default value is true .
|
Extension Methods
Name | Value | Summary |
---|---|---|
NotNull |
void |
Throws an exception if the specified parameter's value is null.
From IssuesArgumentChecks
|