Aliases Class

Summary

Contains functionality related to reading and creating issues.
Assembly
Cake.Issues.dll
Namespace
Cake.Issues
Base Types
  • Object
graph BT Type-->Base0["Object"] Type["Aliases"] class Type type-node

Syntax

public static class Aliases

Attributes

Type Description
CakeAliasCategoryAttribute

Methods

Name Value Summary
BreakBuildOnIssues(ICakeContext, IEnumerable<IIssue>, Func<IIssue, bool>) void
Fails build if any issues are found matching a specific predicate.
static
BreakBuildOnIssues(ICakeContext, IEnumerable<IIssue>, IssuePriority) void
Fails build if any issues of certain minimum priority are found.
static
BreakBuildOnIssues(ICakeContext, IEnumerable<IIssue>, string) void
Fails build if any issues from a specific issue provider are found.
static
BreakBuildOnIssues(ICakeContext, IEnumerable<IIssue>) void
Fails build if any issues are found.
static
DeserializeIssueFromJsonFile(ICakeContext, FilePath) Issue
Deserializes an Issue from a JSON file.
static
DeserializeIssueFromJsonString(ICakeContext, string) Issue
Deserializes an Issue from a JSON string.
static
DeserializeIssuesFromJsonFile(ICakeContext, FilePath) IEnumerable<Issue>
Deserializes an IEnumerable<T> from a JSON file.
static
DeserializeIssuesFromJsonString(ICakeContext, string) IEnumerable<Issue>
Deserializes an IEnumerable<T> from a JSON string.
static
IssueFileLinkSettings(ICakeContext, Func<IIssue, Uri>) FileLinkSettings
Gets an instance of the file link settings for linking to files based on a custom action.
static
IssueFileLinkSettings(ICakeContext, string) FileLinkSettings
Gets an instance of the file link settings for linking to files based on a custom pattern.
static
IssueFileLinkSettingsForAzureDevOpsBranch(ICakeContext, Uri, string, string) FileLinkSettings
Gets an instance of the file link settings for linking to files hosted in Azure DevOps in a sub-folder on a specific branch.
static
IssueFileLinkSettingsForAzureDevOpsBranch(ICakeContext, Uri, string) FileLinkSettings
Gets an instance of the file link settings for linking to files hosted in Azure DevOps on a specific branch.
static
IssueFileLinkSettingsForAzureDevOpsCommit(ICakeContext, Uri, string, string) FileLinkSettings
Gets an instance of the file link settings for linking to files hosted in Azure DevOps in a sub-folder for a specific commit.
static
IssueFileLinkSettingsForAzureDevOpsCommit(ICakeContext, Uri, string) FileLinkSettings
Gets an instance of the file link settings for linking to files hosted in Azure DevOps for a specific commit.
static
IssueFileLinkSettingsForGitHubBranch(ICakeContext, Uri, string, string) FileLinkSettings
Gets an instance of the file link settings for linking files hosted on GitHub in a sub-folder on a specific branch.
static
IssueFileLinkSettingsForGitHubBranch(ICakeContext, Uri, string) FileLinkSettings
Gets an instance of the file link settings for linking files hosted on GitHub on a specific branch.
static
IssueFileLinkSettingsForGitHubCommit(ICakeContext, Uri, string, string) FileLinkSettings
Gets an instance of the file link settings for linking files hosted on GitHub in a sub-folder for a specific commit.
static
IssueFileLinkSettingsForGitHubCommit(ICakeContext, Uri, string) FileLinkSettings
Gets an instance of the file link settings for linking files hosted on GitHub fo a specific commit.
static
NewIssue(ICakeContext, string, string, string, string) IssueBuilder
Initiates the creation of a new IIssue.
static
NewIssue(ICakeContext, string, string, string) IssueBuilder
Initiates the creation of a new IIssue with message as identifier.
static
ReadIssues(ICakeContext, IEnumerable<IIssueProvider>, DirectoryPath) IEnumerable<IIssue>
Reads issues from issue providers.
static
ReadIssues(ICakeContext, IEnumerable<IIssueProvider>, IReadIssuesSettings) IEnumerable<IIssue>
Reads issues from issue providers using the specified settings.
static
ReadIssues(ICakeContext, IIssueProvider, DirectoryPath) IEnumerable<IIssue>
Reads issues from a single issue provider.
static
ReadIssues(ICakeContext, IIssueProvider, IReadIssuesSettings) IEnumerable<IIssue>
Reads issues from a single issue provider using the specified settings.
static
SerializeIssuesToJsonFile(ICakeContext, IEnumerable<IIssue>, FilePath) void
Serializes an IEnumerable<T> to a JSON file.
static
SerializeIssuesToJsonString(ICakeContext, IEnumerable<IIssue>) string
Serializes an IEnumerable<T> to a JSON string.
static
SerializeIssueToJsonFile(ICakeContext, IIssue, FilePath) void
Serializes an IIssue to a JSON file.
static
SerializeIssueToJsonString(ICakeContext, IIssue) string
Serializes an IIssue to a JSON string.
static

Extension Methods

Name Value Summary
ToDictionary() IDictionary<string, object>
Requires the Cake.DeployParams addin
ToStringWithNullMarkup() string
Returns the string value or a Not set> markup suitable for Spectre.Console.
Requires the Cake.Issues addin