Cake.Issues.DocFx 4.10.0

为 Cake 构建自动化系统中的 Cake.Issues 附加组件提供 DocFx 支持

注意：这是与 Cake .NET 工具 兼容的附加组件版本。有关与 Cake Frosting 兼容的附加组件，请参阅 Cake.Frosting.Issues.DocFx。

DocFx 支持允许您读取来自 DocFx 日志文件中的警告。

Cake.Issues 通过提供全面、通用且可扩展的解决方案，重新定义了 Cake 构建系统中的问题管理。附加组件的独特功能使开发团队能够强制执行编码标准、生成有洞察力的报告、无缝集成各种代码分析工具，并简化与拉取请求的集成。凭借其 模块化架构 和广泛 别名集合，Cake.Issues 为 Cake 构建中的问题管理提供了一个面向未来的基础设施，促进了更高效、更可适应的开发过程。

有关更多信息及详细文档，请参阅 Cake.Issues 网站。有关 Cake 构建自动化系统的通用信息，请参阅 Cake 网站。

使用方法

将 Cake.Issues 集成到您的 Cake 构建中非常简单。通过最小设置，团队可以享受将增强的代码质量管理无缝集成到现有构建管道中的好处。

添加插件后，可以解析 DocFx 构建日志文件

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());
});

支持 & 讨论

如有问题或想讨论想法及功能请求，请访问 Cake GitHub 仓库的 GitHub 讨论区 下的 扩展问答 类别。

贡献

欢迎贡献力量。请参阅 贡献指南。

许可证

MIT 许可证 - 版权 © Cake Issues 贡献者

某些插件的二进制分布包含第三方代码，这些代码受其自身相应的许可证约束。有关详细信息，请参阅 LICENSE。