ReleaseNotes Class

Summary

Represent release notes.
Namespace
Cake.Common
Base Types
  • object
graph BT Type-->Base0["object"] Type["ReleaseNotes"] class Type type-node

Syntax

public sealed class ReleaseNotes

Constructors

Name Summary
ReleaseNotes(SemVersion, IEnumerable<string>, string) Initializes a new instance of the ReleaseNotes class.
ReleaseNotes(Version, IEnumerable<string>, string) Initializes a new instance of the ReleaseNotes class.

Properties

Name Value Summary
Notes IReadOnlyList<string>
Gets the release notes.
RawVersionLine string
Gets the raw text of the line that Version was extracted from.
SemVersion SemVersion
Gets the version.
Version Version
Gets the version.

Extension Methods

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