GitReleaseNotesAliases Class

Summary

Contains functionality related to GitReleaseNotes.

In order to use the commands for this alias, include the following in your build.cake file to download and install from nuget.org, or specify the ToolPath within the GitReleaseNotesSettings class: 

#tool "nuget:?package=GitReleaseNotes"

Namespace
Cake.Common.Tools.GitReleaseNotes
Base Types
  • object
graph BT Type-->Base0["object"] Type["GitReleaseNotesAliases"] class Type type-node

Syntax

[CakeAliasCategory("GitReleaseNotes")]
public static class GitReleaseNotesAliases

Attributes

Type Description
CakeAliasCategoryAttribute An attribute used for documentation of alias methods/properties.

Methods

Name Value Summary
GitReleaseNotes(ICakeContext, FilePath, GitReleaseNotesSettings) void
Generates a set of release notes based on the commit history of the repository and specified settings.
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