Cake.Issues

The issues addin allows you to read issue from any code analyzer or linter. This addin provides the aliases for reading issues. It also requires one or more issue provider addins for the specific code analyzer or linter. 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&version=4.9.0

dotnet add package Cake.Issues --version 4.9.0

<PackageReference Include="Cake.Issues" Version="4.9.0" />

Aliases

Build Breaking

BreakBuildOnIssues(IEnumerable<IIssue>, Func<IIssue, bool>)
BreakBuildOnIssues(IEnumerable<IIssue>, IssuePriority)
BreakBuildOnIssues(IEnumerable<IIssue>, string)
BreakBuildOnIssues(IEnumerable<IIssue>)

Creating Issues

NewIssue(string, string, string, string)
NewIssue(string, string, string)

File Linking

IssueFileLinkSettings(Func<IIssue, Uri>)
IssueFileLinkSettings(string)
IssueFileLinkSettingsForAzureDevOpsBranch(Uri, string, string)
IssueFileLinkSettingsForAzureDevOpsBranch(Uri, string)
IssueFileLinkSettingsForAzureDevOpsCommit(Uri, string, string)
IssueFileLinkSettingsForAzureDevOpsCommit(Uri, string)
IssueFileLinkSettingsForGitHubBranch(Uri, string, string)
IssueFileLinkSettingsForGitHubBranch(Uri, string)
IssueFileLinkSettingsForGitHubCommit(Uri, string, string)
IssueFileLinkSettingsForGitHubCommit(Uri, string)

Issue Serialization

DeserializeIssueFromJsonFile(FilePath)
DeserializeIssueFromJsonString(string)
DeserializeIssuesFromJsonFile(FilePath)
DeserializeIssuesFromJsonString(string)
SerializeIssuesToJsonFile(IEnumerable<IIssue>, FilePath)
SerializeIssuesToJsonString(IEnumerable<IIssue>)
SerializeIssueToJsonFile(IIssue, FilePath)
SerializeIssueToJsonString(IIssue)

Reading Issues

ReadIssues(IEnumerable<IIssueProvider>, DirectoryPath)
ReadIssues(IEnumerable<IIssueProvider>, IReadIssuesSettings)
ReadIssues(IIssueProvider, DirectoryPath)
ReadIssues(IIssueProvider, IReadIssuesSettings)