This content is part of a third party extension that is not supported by the Cake project. For more information about this extension see Cake.GitHub.

Summary

Provides information about a GitHub Release.

Assembly

Cake.GitHub.dll

Namespace

Cake.GitHub

Base Types

graph BT Type-->Base0["Object"] Type["GitHubRelease"] class Type type-node

Syntax

public sealed class GitHubRelease

Type	Description
NullableContextAttribute
NullableAttribute

Name	Summary
GitHubRelease(long, string, string, string, string, string, bool, bool, DateTime, Nullable<DateTime>)	Initializes a new instance of `GitHubRelease`

Name	Value	Summary
Assets	IReadOnlyList<GitHubReleaseAsset>	Gets the release's assets.
Body	string	Gets the release's description (a Markdown string).
CreatedAt	DateTime	Gets the time the release was created.
Draft	bool	Gets whether the release is a draft release.
HtmlUrl	string	Gets the url of the release in the GitHub web interface.
Id	long	Gets the release's id
Name	string	Gets the release's name.
Prerelease	bool	Gets whether the release was marked as prerelease.
PublishedAt	Nullable<DateTime>	Gets the time the release was published.
TagName	string	Gets the name of the tag the release was created for.
TargetCommitish	string	Gets the SHA of the git commit the release refers to.

Name	Value	Summary
Dump<GitHubRelease>()	string	Get a basic string representation of specified object. From LoggingExtensions Requires the Cake.Incubator addin
IsIn<GitHubRelease>(GitHubRelease[])	bool	Checks if the source is contained in a list From EnumerableExtensions Requires the Cake.Incubator addin
NotNull<GitHubRelease>(string)	void	Throws an exception if the specified parameter's value is null. From Extensions Requires the Cake.Ftp addin
NotNull<GitHubRelease>(string)	void	Throws an exception if the specified parameter's value is null. From IssuesArgumentChecks Requires the Cake.Issues addin
ThrowIfNull<GitHubRelease>(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<GitHubRelease>(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