Cake.Frosting.Issues.DocFx 4.12.0

.NET 6.0 This package targets .NET 6.0. The package is compatible with this framework or higher.
There is a newer prerelease version of this package available.
See the version list below for details. 
dotnet add package Cake.Frosting.Issues.DocFx --version 4.12.0                

                    
                

            
NuGet\Install-Package Cake.Frosting.Issues.DocFx -Version 4.12.0
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package. 
<PackageReference Include="Cake.Frosting.Issues.DocFx" Version="4.12.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
paket add Cake.Frosting.Issues.DocFx --version 4.12.0                

                    
                

            
#r "nuget: Cake.Frosting.Issues.DocFx, 4.12.0"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package. 
#addin nuget:?package=Cake.Frosting.Issues.DocFx&version=4.12.0

DocFx support for the Cake.Issues addin for Cake Frosting

NOTE: This is the version of the addin compatible with Cake Frosting. For addin compatible with Cake .NET Tool see Cake.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 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.

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:

[TaskName("Build-Documentation")]
public sealed class BuildDocumentationTask : FrostingTask<BuildContext>
{
    public override void Run(BuildContext context)
    {
        var logPath = @"c:\build\docfx.log";
        var repoRootPath = @"c:\repo";
        var docRootPath = @"docs";

        // Run DocFx using Cake.DocFx addin.
        context.DocFxBuild(new DocFxBuildSettings()
        {
            LogPath = logPath
        });

        // Read issues.
        var issues =
            context.ReadIssues(
                context.DocFxIssuesFromFilePath(logPath, docRootPath),
                repoRootPath);

        context.Information("{0} issues are found.", issues.Count());
    }
}

Support & Discussion

For questions and to discuss ideas & feature requests, use the GitHub discussions on the Cake GitHub repository, under the Extension Q&A category.

Contributing

Contributions are welcome. See Contribution Guidelines.

License

MIT License - Copyright © Cake Issues contributors

Binary distributions for some addins contain third-party code which is licensed under its own respective license. See LICENSE for details.

Product Compatible and additional computed target framework versions.
.NET net6.0 is compatible.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 is compatible.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
5.0.0-beta0002 58 11/23/2024
5.0.0-beta0001 61 11/18/2024
4.12.0 74 11/5/2024
4.11.0 82 10/6/2024
4.10.1 136 8/20/2024
4.10.0 65 7/30/2024
4.9.0 76 7/25/2024
4.8.1 87 7/19/2024
4.8.0 88 7/19/2024
4.7.2 89 7/18/2024
4.7.1 91 7/17/2024
4.7.0 85 7/16/2024
4.6.0 93 6/24/2024
4.5.1 101 5/24/2024
4.5.0 83 5/23/2024
4.4.0 78 5/18/2024
4.3.1 103 4/25/2024
4.3.0 107 4/20/2024
4.2.1 116 4/16/2024
4.2.0 121 4/14/2024

https://github.com/cake-contrib/Cake.Issues/releases/tag/4.12.0