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 : GitHubSettingsBaseAttributes
| Type | Description |
|---|---|
| Nullable |
|
| NullableAttribute |
Constructors
| Name | Summary |
|---|---|
| Git |
Properties
| Name | Value | Summary |
|---|---|---|
| Assets | IList |
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
| Name | Value | Summary |
|---|---|---|
| Dump |
string |
Get a basic string representation of specified object.
From LoggingExtensions
Requires the Cake.Incubator addin
|
| IsIn |
bool |
Checks if the source is contained in a list
From EnumerableExtensions
Requires the Cake.Incubator addin
|
| NotNull |
void |
Throws an exception if the specified parameter's value is null.
From Extensions
Requires the Cake.Ftp addin
|
| NotNull |
void |
Throws an exception if the specified parameter's value is null.
From IssuesArgumentChecks
Requires the Cake.Issues addin
|
| ThrowIfNull |
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 |
T |
Throws a
System.ArgumentNullException if the value is null, otherwise returns the value
From AssertExtensions
Requires the Cake.Incubator addin
|
| ToDictionary |
IDictionary |
From ObjectHelpers
Requires the Cake.DeployParams addin
|
| To |
string |
Returns the string value or a
Not set> markup suitable for Spectre.Console.
From StringExtensions
Requires the Cake.Issues addin
|