The DocFx support for the Cake.Issues addin for Cake allows you to read warnings from DocFx log files. This addin provides the aliases for reading warnings from DocFx log files and provides them to the Cake.Issues addin. It also requires the core Cake.Issues addin. 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. NOTE: This is the version of the addin compatible with Cake Script Runners. For addin compatible with Cake Frosting see Cake.Frosting.Issues.DocFx.
Get Started
$ dotnet add package Cake.Issues.DocFxReadme
DocFx support for the Cake.Issues addin for Cake Build Automation System
NOTE: This is the version of the addin compatible with Cake .NET Tool. For addin compatible with Cake Frosting see Cake.Frosting.Issues.DocFx.
The DocFx support for the Cake.Issues addin for Cake allows you to read warnings from DocFx log files.
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 streamline the integration with build servers and 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.
How to use
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.
After adding the addin the log file of a DocFx build can be parsed:
Task("Build-Documentation").Does(() =>
{
var logPath = @"c:\build\docfx.log";
var repoRootPath = @"c:\repo";
var docRootPath = @"docs";
// Run DocFx using Cake.DocFx addin.
DocFxBuild(new DocFxBuildSettings()
{
LogPath = logPath
});
// Read issues.
var issues =
ReadIssues(
DocFxIssuesFromFilePath(logPath, docRootPath),
repoRootPath);
Information("{0} issues are found.", issues.Count());
});