GitReleaseManagerTool<TSettings> Class

Summary

Base class for all GitReleaseManager related tools.
Namespace
Cake.Common.Tools.GitReleaseManager
Base Types
Derived Types
graph BT Type-->Base0["Tool<TSettings>"] Base0-->Base1["object"] Type["GitReleaseManagerTool<TSettings>"] class Type type-node Derived0["GitReleaseManagerPublisher"]-->Type click Derived0 "/api/Cake.Common.Tools.GitReleaseManager.Publish/GitReleaseManagerPublisher" Derived1["GitReleaseManagerMilestoneOpener"]-->Type click Derived1 "/api/Cake.Common.Tools.GitReleaseManager.Open/GitReleaseManagerMilestoneOpener" Derived2["GitReleaseManagerDiscarder"]-->Type click Derived2 "/api/Cake.Common.Tools.GitReleaseManager.Discard/GitReleaseManagerDiscarder" Derived3["GitReleaseManagerAssetsAdder"]-->Type click Derived3 "/api/Cake.Common.Tools.GitReleaseManager.AddAssets/GitReleaseManagerAssetsAdder" Derived4["GitReleaseManagerLabeller"]-->Type click Derived4 "/api/Cake.Common.Tools.GitReleaseManager.Label/GitReleaseManagerLabeller" Derived5["GitReleaseManagerMilestoneCloser"]-->Type click Derived5 "/api/Cake.Common.Tools.GitReleaseManager.Close/GitReleaseManagerMilestoneCloser" Derived6["GitReleaseManagerCreator"]-->Type click Derived6 "/api/Cake.Common.Tools.GitReleaseManager.Create/GitReleaseManagerCreator" Derived7["GitReleaseManagerExporter"]-->Type click Derived7 "/api/Cake.Common.Tools.GitReleaseManager.Export/GitReleaseManagerExporter"

Syntax

public abstract class GitReleaseManagerTool<TSettings> : Tool<TSettings> 
    where TSettings : ToolSettings

Type Parameters

Name Description
TSettings The settings type.

Constructors

Name Summary
GitReleaseManagerTool(IFileSystem, ICakeEnvironment, IProcessRunner, IToolLocator) Initializes a new instance of the GitReleaseManagerTool<TSettings> class.

Methods

Name Value Summary
AddBaseArguments(GitReleaseManagerSettings, ProcessArgumentBuilder) ProcessArgumentBuilder
Adds common arguments to the process builder.
GetToolExecutableNames() IEnumerable<string>
Gets the possible names of the tool executable.
GetToolName() string
Gets the name of the tool.

Extension Methods

Name Value Summary
Dump<GitReleaseManagerTool<TSettings>>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
IsIn<GitReleaseManagerTool<TSettings>>(GitReleaseManagerTool<TSettings>[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<GitReleaseManagerTool<TSettings>>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
NotNull<GitReleaseManagerTool<TSettings>>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Issues addin
ThrowIfNull<GitReleaseManagerTool<TSettings>>(string, string) T
Throws a System.ArgumentNullException with a specific message if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ThrowIfNull<GitReleaseManagerTool<TSettings>>(string) T
Throws a System.ArgumentNullException if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
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