diff --git a/nuspec/nuget/Cake.Issues.Testing.nuspec b/nuspec/nuget/Cake.Issues.Testing.nuspec index afd01b326..df61480f8 100644 --- a/nuspec/nuget/Cake.Issues.Testing.nuspec +++ b/nuspec/nuget/Cake.Issues.Testing.nuspec @@ -16,7 +16,7 @@ Common helpers for testing add-ins based on Cake.Issues false Copyright © BBT Software AG and contributors Cake Script Cake-Issues Issues Testing - https://github.com/cake-contrib/Cake.Issues/releases/tag/0.3.0 + https://github.com/cake-contrib/Cake.Issues/releases/tag/0.3.1 diff --git a/nuspec/nuget/Cake.Issues.nuspec b/nuspec/nuget/Cake.Issues.nuspec index 774e29fe6..b71c1f4bc 100644 --- a/nuspec/nuget/Cake.Issues.nuspec +++ b/nuspec/nuget/Cake.Issues.nuspec @@ -23,7 +23,7 @@ See the Project Site for an overview of the whole ecosystem of addins for workin false Copyright © BBT Software AG and contributors Cake Script Cake-Issues CodeAnalysis Linting Issues - https://github.com/cake-contrib/Cake.Issues/releases/tag/0.3.0 + https://github.com/cake-contrib/Cake.Issues/releases/tag/0.3.1 diff --git a/src/Cake.Issues/Aliases.cs b/src/Cake.Issues/Aliases.cs index 3867af454..1a9056dce 100644 --- a/src/Cake.Issues/Aliases.cs +++ b/src/Cake.Issues/Aliases.cs @@ -11,6 +11,45 @@ [CakeAliasCategory(IssuesAliasConstants.MainCakeAliasCategory)] public static class Aliases { + /// + /// Initiates the creation of a new . + /// + /// The context. + /// The message of the issue. + /// The unique identifier of the issue provider. + /// The human friendly name of the issue provider. + /// Builder class for creating a new . + /// + /// Create a new warning for the myfile.txt file on line 42: + /// + /// + /// + /// + [CakeMethodAlias] + [CakeAliasCategory(IssuesAliasConstants.CreateCakeAliasCategory)] + public static IssueBuilder NewIssue( + this ICakeContext context, + string message, + string providerType, + string providerName) + { + context.NotNull(nameof(context)); + message.NotNullOrWhiteSpace(nameof(message)); + providerType.NotNullOrWhiteSpace(nameof(providerType)); + providerName.NotNullOrWhiteSpace(nameof(providerName)); + + return IssueBuilder.NewIssue(message, providerType, providerName); + } + /// /// Reads issues from a single issue provider. /// diff --git a/src/Cake.Issues/IssueBuilder.cs b/src/Cake.Issues/IssueBuilder.cs index aba4dae3e..17b8441bc 100644 --- a/src/Cake.Issues/IssueBuilder.cs +++ b/src/Cake.Issues/IssueBuilder.cs @@ -3,7 +3,7 @@ using System; /// - /// Class to create instances of with a fluent API. + /// Class to create instances of with a fluent API. /// public class IssueBuilder { @@ -39,12 +39,12 @@ private IssueBuilder( } /// - /// Creates a new instance of the class. + /// Initiates the creation of a new . /// /// The message of the issue. /// The type of the issue provider. /// The human friendly name of the issue provider. - /// New issue + /// Builder class for creating a new issue. public static IssueBuilder NewIssue( string message, string providerType, @@ -58,12 +58,12 @@ public static IssueBuilder NewIssue( } /// - /// Creates a new instance of the class. + /// Initiates the creation of a new . /// /// Type of the issue provider which has the issue created. /// The message of the issue. /// Issue provider which has the issue created. - /// New issue + /// Builder class for creating a new issue. public static IssueBuilder NewIssue( string message, T issueProvider) @@ -126,9 +126,9 @@ public IssueBuilder InFile(string filePath, int? line) } /// - /// Sets the priority of the message. + /// Sets the priority of the issue. /// - /// The priority of the message. + /// The priority of the issue. /// Issue Builder instance. public IssueBuilder WithPriority(IssuePriority priority) { @@ -136,9 +136,9 @@ public IssueBuilder WithPriority(IssuePriority priority) } /// - /// Sets the priority of the message. + /// Sets the priority of the issue. /// - /// The priority of the message. + /// The priority of the issue. /// null if no priority should be assigned. /// The human friendly name of the priority. /// null or if no priority should be assigned. @@ -181,7 +181,7 @@ public IssueBuilder OfRule(string name, Uri uri) } /// - /// Creates a new . + /// Creates a new . /// /// New issue object. public IIssue Create() diff --git a/src/Cake.Issues/IssuesAliasConstants.cs b/src/Cake.Issues/IssuesAliasConstants.cs index 6203932be..94c45aa39 100644 --- a/src/Cake.Issues/IssuesAliasConstants.cs +++ b/src/Cake.Issues/IssuesAliasConstants.cs @@ -10,6 +10,11 @@ public static class IssuesAliasConstants /// public const string MainCakeAliasCategory = "Issues"; + /// + /// Category to use for all Cake aliases providing functionality for creating issues. + /// + public const string CreateCakeAliasCategory = "Creating Issues"; + /// /// Category to use for all Cake aliases providing functionality for reading issues. ///