The issues addin for Cake allows you to read issue from any code analyzer or linter. This addin provides the aliases for reading issues. It also requires one or more issue provider addins for the specific code analyzer or linter. There are also additional addins for generating reports or posting issues to pull requests. See the Project Site for an overview of the whole ecosystem of addins for working with issues in Cake scripts.
$ dotnet add package Cake.IssuesThe issues addin for Cake allows you to read issue from any code analyzer or linter.
Cake.Issues redefines issue management within the Cake build system by offering a comprehensive, universal, and extensible solution. The unique capabilities of the addins empower development teams to enforce coding standards, generate insightful reports, seamlessly incorporate various linting tools, and streamlining the integration with pull requests. With its modular architecture and extensive set of aliases, Cake.Issues provides a future-proof infrastructure for issue management in Cake builds, fostering a more efficient and adaptable development process.
For more information and extensive documentation see the Cake.Issues website. For general information about the Cake build automation system see the Cake website.
Integrating Cake.Issues into your Cake build is straightforward. With minimal setup, teams can enjoy the benefits of enhanced code quality management seamlessly integrated into their existing build pipeline.
The addin provides the ReadIssues alias to read issues.
It needs an additional NuGet packages to provide the specific issue provider implementation.
See Issue Providers for a list of available issue providers.
To create issues directly in the build script the NewIssue alias can be used:
[TaskName("Create-Issue")]
public sealed class CreateIssueTask : FrostingTask<BuildContext>
{
public override void Run(BuildContext context)
{
var issue =
context
.NewIssue(
"Something went wrong",
"MyCakeScript",
"My Cake Script")
.WithMessageInHtmlFormat("Something went <b>wrong</b>")
.WithMessageInMarkdownFormat("Something went **wrong**")
.InFile("myfile.txt", 42)
.WithPriority(IssuePriority.Warning)
.Create();
context.Information("Issue created with message: {0}", issues.MessageText);
}
}
Issue reports can be created using any of the available Report Format addin.
Issues can be written as comments to pull requests or reported to build systems using any of the available Pull Request System addin.
For questions and to discuss ideas & feature requests, use the GitHub discussions on the Cake GitHub repository, under the Extension Q&A category.
Contributions are welcome. See Contribution Guidelines.
Binary distributions for some addins contain third-party code which is licensed under its own respective license. See LICENSE for details.