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

Settings for creating a GitHub Release

Assembly

Cake.GitHub.dll

Namespace

Cake.GitHub

Base Types

Object
GitHubSettingsBase

graph BT Type-->Base0["GitHubSettingsBase"] click Base0 "/api/Cake.GitHub/GitHubSettingsBase" Base0-->Base1["Object"] Type["GitHubCreateReleaseSettings"] class Type type-node

Syntax

public sealed class GitHubCreateReleaseSettings : GitHubSettingsBase

Attributes

Type	Description
NullableContextAttribute
NullableAttribute

Constructors

Name	Summary
GitHubCreateReleaseSettings()

Properties

Name	Value	Summary
Assets	IList<FilePath>	Gets or sets the paths of the files to upload as release assets.
Body	string	Gets or sets the release's description.
Draft	bool	Gets or sets whether to create a draft release.
Name	string	Gets or sets the name of the release to. Defaults to the tag name when not specified.
Overwrite	bool	Gets or sets whether to replace an existing release.
Prerelease	bool	Gets or sets whether to mark the release as "prerelease".
TargetCommitish	string	Gets or sets the Git commit it to create the tag from. Can be any branch of commit SHA. Value is unused if the release's tag already exists.

Extension Methods