Summary

The GitReleaseNotes runner.

Namespace

Cake.Common.Tools.GitReleaseNotes

Base Types

graph BT Type-->Base0["Tool<GitReleaseNotesSettings>"] Base0-->Base1["object"] Type["GitReleaseNotesRunner"] class Type type-node

Syntax

public sealed class GitReleaseNotesRunner : Tool<GitReleaseNotesSettings>

Name	Summary
GitReleaseNotesRunner(IFileSystem, ICakeEnvironment, IProcessRunner, IToolLocator)	Initializes a new instance of the `GitReleaseNotesRunner` class.

Name	Value	Summary
GetToolExecutableNames()	IEnumerable<string>	Gets the possible names of the tool executable.
GetToolName()	string	Gets the name of the tool.
Run(FilePath, GitReleaseNotesSettings)	void	Runs GitVersion and processes the results.

Name	Value	Summary
Dump<GitReleaseNotesRunner>()	string	Get a basic string representation of specified object. From LoggingExtensions Requires the Cake.Incubator addin
IsIn<GitReleaseNotesRunner>(GitReleaseNotesRunner[])	bool	Checks if the source is contained in a list From EnumerableExtensions Requires the Cake.Incubator addin
NotNull<GitReleaseNotesRunner>(string)	void	Throws an exception if the specified parameter's value is null. From Extensions Requires the Cake.Ftp addin
NotNull<GitReleaseNotesRunner>(string)	void	Throws an exception if the specified parameter's value is null. From IssuesArgumentChecks Requires the Cake.Issues addin
ThrowIfNull<GitReleaseNotesRunner>(string, string)	T	Throws a `System.ArgumentNullException` with a specific message if the value is null, otherwise returns the value From AssertExtensions Requires the Cake.Incubator addin
ThrowIfNull<GitReleaseNotesRunner>(string)	T	Throws a `System.ArgumentNullException` if the value is null, otherwise returns the value From AssertExtensions Requires the Cake.Incubator addin
ToDictionary()	IDictionary<string, object>	From ObjectHelpers Requires the Cake.DeployParams addin
ToStringWithNullMarkup()	string	Returns the string value or a `Not set`> markup suitable for Spectre.Console. From StringExtensions Requires the Cake.Issues addin