GitHubRelease Class

Summary

Provides information about a GitHub Release.
Assembly
Cake.GitHub.dll
Namespace
Cake.GitHub
Base Types
  • Object
graph BT Type-->Base0["Object"] Type["GitHubRelease"] class Type type-node

Syntax

public sealed class GitHubRelease

Attributes

Type Description
NullableContextAttribute
NullableAttribute

Constructors

Properties

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.

Extension Methods

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