This page lists configuration properties which can be used to define the functionality and behavior of Cake.Issues recipes.

Git repository information

Cake.Issues recipes require some information about current Git repository.

To define the Git provider in Cake.Issues.Recipe set the global variable RepositoryInfoProvider. To define the Git provider in Cake.Frosting.Issues.Recipe pass the value to the constructor of IssueContext.

The following providers are supported:

Provider	Description
`RepositoryInfoProviderType.CakeGit`	Read repository information using Cake.Git addin. Requires system to be compatible with Cake.Git addin.
`RepositoryInfoProviderType.Cli`	Read repository information using Git CLI. Requires Git CLI to be available in path.

By default Cake.Git addin will be used.

General

Cake.Issues.Recipe Property	Cake.Frosting.Issues.Recipe Property	Default Value	Description
`IssuesParameters.` `OutputDirectory`	`IssuesContext.Parameters.` `OutputDirectory`	`BuildArtifacts`	Path to the output directory. A relative path will be relative to the current working directory.
`IssuesParameters.` `BuildIdentifier`	`IssuesContext.Parameters.` `BuildIdentifier`	`string.Empty`	Identifier for the build run. If set this identifier will be used to identify to artifacts provided by the build if building on multiple configurations.

Input files

Cake.Issues.Recipe Methods	Cake.Frosting.Issues.Recipe Methods	Description
`IssuesParameters.InputFiles.` `AddMsBuildXmlFileLoggerLogFile()`	`IssuesContext.Parameters.InputFiles.` `AddMsBuildXmlFileLoggerLogFile()`	Adds a path to a MSBuild log file created by XmlFileLogger.
`IssuesParameters.InputFiles.` `AddMsBuildBinaryLogFile()`	`IssuesContext.Parameters.InputFiles.` `AddMsBuildBinaryLogFile()`	Adds a path to a MSBuild binary log file.
`IssuesParameters.InputFiles.` `AddInspectCodeLogFile()`	`IssuesContext.Parameters.InputFiles.` `AddInspectCodeLogFile()`	Adds a path to a JetBrains InspectCode log file.
`IssuesParameters.InputFiles.` `AddMarkdownlintCliLogFile()`	`IssuesContext.Parameters.InputFiles.` `AddMarkdownlintCliLogFile()`	Adds a path to a markdownlint-cli log file.
`IssuesParameters.InputFiles.` `AddMarkdownlintCliJsonLogFile()`	`IssuesContext.Parameters.InputFiles.` `AddMarkdownlintCliJsonLogFile()`	Adds a path to a markdownlint-cli log file writting with `--json`.
`IssuesParameters.InputFiles.` `AddMarkdownlintV1LogFile()`	`IssuesContext.Parameters.InputFiles.` `AddMarkdownlintV1LogFile()`	Adds a path to a markdownlint log file in version 1.
`IssuesParameters.InputFiles.` `AddEsLintJsonLogFile()`	`IssuesContext.Parameters.InputFiles.` `AddEsLintJsonLogFile()`	Adds a path to a ESLint log file generated by the ESLint json formatter.

Report creation

Cake.Issues.Recipe Property	Cake.Frosting.Issues.Recipe Property	Default Value	Description
`IssuesParameters.Reporting.` `ShouldCreateFullIssuesReport`	`IssuesContext.Parameters.Reporting.` `ShouldCreateFullIssuesReport`	`true`	Indicates whether full issues report should be created.
`IssuesParameters.Reporting.` `FullIssuesReportSettings`	`IssuesContext.Parameters.Reporting.` `FullIssuesReportSettings`	`GenericIssueReportTemplate.HtmlDxDataGrid` template with `DevExtremeTheme.MaterialBlueLight` theme.	Settings for creating the full issues report. See Template Gallery for possible options.

Build server integration

Cake.Issues.Recipe Property	Cake.Frosting.Issues.Recipe Property	Default Value	Description
`IssuesParameters.BuildServer.` `ShouldReportIssuesToBuildServer`	`IssuesContext.Parameters.BuildServer.` `ShouldReportIssuesToBuildServer`	`true`	Indicates whether issues should be reported to the build server.
`IssuesParameters.BuildServer.` `ShouldPublishFullIssuesReport`	`IssuesContext.Parameters.BuildServer.` `ShouldPublishFullIssuesReport`	`true`	Indicates whether full issues report should be published as artifact to the build system.
`IssuesParameters.BuildServer.` `ShouldCreateSummaryIssuesReport`	`IssuesContext.Parameters.BuildServer.` `ShouldCreateSummaryIssuesReport`	`true`	Indicates whether summary issues report should be created.

Pull request integration