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=5.0.1

dotnet add package Cake.Issues --version 5.0.1

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

Aliases

Contains functionality related to reading and creating issues.

Build Breaking

BreakBuildOnIssues(IEnumerable<IIssue>, Func<IIssue, bool>) Fails build if any issues are found matching a specific predicate.
BreakBuildOnIssues(IEnumerable<IIssue>, IssuePriority) Fails build if any issues of certain minimum priority are found.
BreakBuildOnIssues(IEnumerable<IIssue>, string) Fails build if any issues from a specific issue provider are found.
BreakBuildOnIssues(IEnumerable<IIssue>) Fails build if any issues are found.

Creating Issues

NewIssue(string, string, string, string) Initiates the creation of a new IIssue.
NewIssue(string, string, string) Initiates the creation of a new IIssue with message as identifier.

File Linking

IssueFileLinkSettings(Func<IIssue, Uri>) Gets an instance of the file link settings for linking to files based on a custom action.
IssueFileLinkSettings(string) Gets an instance of the file link settings for linking to files based on a custom pattern.
IssueFileLinkSettingsForAzureDevOpsBranch(Uri, string, string) Gets an instance of the file link settings for linking to files hosted in Azure DevOps in a sub-folder on a specific branch.
IssueFileLinkSettingsForAzureDevOpsBranch(Uri, string) Gets an instance of the file link settings for linking to files hosted in Azure DevOps on a specific branch.
IssueFileLinkSettingsForAzureDevOpsCommit(Uri, string, string) Gets an instance of the file link settings for linking to files hosted in Azure DevOps in a sub-folder for a specific commit.
IssueFileLinkSettingsForAzureDevOpsCommit(Uri, string) Gets an instance of the file link settings for linking to files hosted in Azure DevOps for a specific commit.
IssueFileLinkSettingsForGitHubBranch(Uri, string, string) Gets an instance of the file link settings for linking files hosted on GitHub in a sub-folder on a specific branch.
IssueFileLinkSettingsForGitHubBranch(Uri, string) Gets an instance of the file link settings for linking files hosted on GitHub on a specific branch.
IssueFileLinkSettingsForGitHubCommit(Uri, string, string) Gets an instance of the file link settings for linking files hosted on GitHub in a sub-folder for a specific commit.
IssueFileLinkSettingsForGitHubCommit(Uri, string) Gets an instance of the file link settings for linking files hosted on GitHub fo a specific commit.

Issue Serialization

DeserializeIssueFromJsonFile(FilePath) Deserializes an Issue from a JSON file.
DeserializeIssueFromJsonString(string) Deserializes an Issue from a JSON string.
DeserializeIssuesFromJsonFile(FilePath) Deserializes an IEnumerable<T> from a JSON file.
DeserializeIssuesFromJsonString(string) Deserializes an IEnumerable<T> from a JSON string.
SerializeIssuesToJsonFile(IEnumerable<IIssue>, FilePath) Serializes an IEnumerable<T> to a JSON file.
SerializeIssuesToJsonString(IEnumerable<IIssue>) Serializes an IEnumerable<T> to a JSON string.
SerializeIssueToJsonFile(IIssue, FilePath) Serializes an IIssue to a JSON file.
SerializeIssueToJsonString(IIssue) Serializes an IIssue to a JSON string.

Reading Issues

ReadIssues(IEnumerable<IIssueProvider>, DirectoryPath) Reads issues from issue providers.
ReadIssues(IEnumerable<IIssueProvider>, IReadIssuesSettings) Reads issues from issue providers using the specified settings.
ReadIssues(IIssueProvider, DirectoryPath) Reads issues from a single issue provider.
ReadIssues(IIssueProvider, IReadIssuesSettings) Reads issues from a single issue provider using the specified settings.