How Cake Issues Works

The Cake Issues addins are built in a modular architecture, allowing to easily enhance it for supporting additional analyzers, linters, report formats and pull request systems.

Architecture Overview

Cake.Issues addin¶

The Cake.Issues addin provides aliases for creating issues or reading issues using one or more issue providers.

Support for different code analyzers and linters is provided through issue provider addins which cover a wide range of linters and tools.

The issues are read into IIssue objects which then can be passed to Cake.Issues.Reporting addin, Cake.Issues.PullRequests addin or further processed in the build script.

The use of issue provider addins, which contain the parsing logic for individual tool output formats, and the use of IIssue as common data structure, allows to abstract the tooling output from other concerns like integration with build systems, pull request workflow or the creation of reports.

Cake.Issues.Reporting addin¶

The Cake.Issues.Reporting addin provides aliases for creating reports for issues which are read or have been created using the Cake.Issues addin.

Support for different report formats is provided through report format addins.

Cake.Issues.PullRequests addin¶

The Cake.Issues.PullRequests addin provides aliases for reporting issues which are read or have been created using the Cake.Issues addin as comments to pull requests or builds.

Support for different pull request systems is provided through pull request system addins.