Features
Ready To Use Distributions¶
-
Cake Recipe Packages
Cake Issues recipes provide build scripts, delivered as a NuGet package, which can be used inside your projects Cake build to add issue management.
It handles all the parsing, integration with build and pull request systems for you, using the individual Cake Issues addins.
Reading & Creating Issues¶
-
Read issues provided by tools
The
ReadIssues
aliases can be used for reading issues reported by a linter to tool using an issue provider.There are overloads for reading using a single or multiple issue provider.
-
Create issues in your build
The
NewIssue
aliases can be used for creating issues in the build script. -
Support for file links
Support for creating links to file & location on source code hosting system (GitHub, Azure Repos, etc).
-
Issue serialization
Support for serializing and deserializing created issues and issues read from tools.
-
Support for multiple message formats
Support for reading issues in multiple formats (Plain text, Markdown, HTML) if supported by issue provider.
-
Support for run information
Support for passing additional run information to identify specific runs.
Breaking builds¶
-
Fail builds on reported issues
The
BreakBuildOnIssues
aliases can be used for failing builds if specific issues were reported.There are overloads for failing if issues of certain minimum priority or issue providers are found, or by passing any custom function.
Reporting¶
-
Create reports
The
CreateIssueReport
aliases can be used for creating reports in a supported reporting format.There are overloads for reading issues from a single or multiple issue provider or for passing an existing list of issues.
Build & Pull Request System Integration¶
-
Add comments to pull requests
The
ReportIssuesToPullRequest
aliases can be used for writing issues as comments to pull requests.There are overloads for reading issues from a single or multiple issue provider or for passing an existing list of issues.
-
Report issues to build runs
The
ReportIssuesToPullRequest
aliases can be used for reporting issues to build runs.There are overloads for reading issues from a single or multiple issue provider or for passing an existing list of issues.
-
Issue filters
Support for passing custom issue filter routines.
-
Limit reported issues
Advanced support to limit number of maximum issues per run, across multiple runs or per issue provider through settings.
-
Automatic comment resolving
If supported by the pull request system, comments for issues are automatic resolved if fixed in subsequent commits.