Cake.Issues.DocFx

The DocFx support for the Cake.Issues addin 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 cakeissues.net for an overview of the whole ecosystem of addins for working with issues in Cake scripts.

#addin nuget:?package=Cake.Issues.DocFx&version=0.9.0

<package id="Cake.Issues.DocFx" version="0.9.0" />

dotnet add package Cake.Issues.DocFx --version 0.9.0

<PackageReference Include="Cake.Issues.DocFx" Version="0.9.0" />

Aliases

Contains functionality related to read warnings from DocFx log files.

Issue Providers

DocFxIssues(ICakeContext, DocFxIssuesSettings) Gets an instance of a provider for warnings reported by DocFx using specified settings.
DocFxIssuesFromContent(ICakeContext, string) Gets an instance of a provider for warnings reported by DocFx using log file content for a DocFx project in the repository root.
DocFxIssuesFromContent(ICakeContext, string, DirectoryPath) Gets an instance of a provider for warnings reported by DocFx using log file content.
DocFxIssuesFromFilePath(ICakeContext, FilePath) Gets an instance of a provider for warnings reported by DocFx using a log file from disk for a DocFx project in the repository root.
DocFxIssuesFromFilePath(ICakeContext, FilePath, DirectoryPath) Gets an instance of a provider for warnings reported by DocFx using a log file from disk.
DocFxIssuesProviderTypeName Gets the name of the DocFx issue provider. This name can be used to identify issues based on the ProviderType property.