Skip to content

Commit 878952a

Browse files
committed
Add new configuration options for Cake.Issues.Recipe
1 parent 7af5112 commit 878952a

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed

docs/input/documentation/recipe/configuration.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -153,3 +153,24 @@ By default [Cake.Git addin](https://cakebuild.net/extensions/cake-git/){target="
153153
| `IssueFilters` | Empty | List of filter functions which should be applied before posting issues to pull requests. |
154154
| `ShouldSetPullRequestStatus` | `true` | Indicates whether a status on the pull request should be set if there are any issues found. |
155155
| `ShouldSetSeparatePullRequestStatusForEachIssueProviderAndRun` | `true` | Indicates whether a separate status should be set for issues of every issue provider and run. |
156+
157+
## Build breaking
158+
159+
=== "Cake.Issues.Recipe"
160+
161+
| IssuesParameters.BuildBreaking Property | Default Value | Description |
162+
|-----------------------------------------|---------------------------|------------------------------------------------------------------------------------------------------------------------------|
163+
| `ShouldFailBuildOnIssues` | `false` | Indicates whether build should fail if any issues are found. |
164+
| `MinimumPriority` | `IssuePriority.Undefined` | The minimum priority of issues considered to fail the build. If set to `IssuePriority.Undefined`, all issues are considered. |
165+
| `IssueProvidersToConsider` | `[]` | List of issue provider types to consider. |
166+
| `IssueProvidersToIgnore` | `[]` | List of issue provider types to ignore. |
167+
168+
=== "Cake.Frosting.Issues.Recipe"
169+
170+
| IssuesContext.Parameters.BuildBreaking Property | Default Value | Description |
171+
|-------------------------------------------------|---------------------------|------------------------------------------------------------------------------------------------------------------------------|
172+
| `ShouldFailBuildOnIssues` | `false` | Indicates whether build should fail if any issues are found. |
173+
| `MinimumPriority` | `IssuePriority.Undefined` | The minimum priority of issues considered to fail the build. If set to `IssuePriority.Undefined`, all issues are considered. |
174+
| `IssueProvidersToConsider` | `[]` | List of issue provider types to consider. |
175+
| `IssueProvidersToIgnore` | `[]` | List of issue provider types to ignore. |
176+

0 commit comments

Comments
 (0)