Class GitHubReleaseSettingsExtensions

Used within GitHubTasks.

Inheritance

System.Object

GitHubReleaseSettingsExtensions

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Nuke.GitHub

Assembly: Nuke.GitHub.dll

Syntax

[PublicAPI]
public static class GitHubReleaseSettingsExtensions

Methods

DisablePrerelease(GitHubReleaseSettings)

Disables Prerelease.

Whether this is a pre-release

Declaration

[Pure]
public static GitHubReleaseSettings DisablePrerelease(this GitHubReleaseSettings toolSettings)

Parameters

Type	Name	Description
GitHubReleaseSettings	toolSettings

Returns

Type	Description
GitHubReleaseSettings

EnablePrerelease(GitHubReleaseSettings)

Enables Prerelease.

Whether this is a pre-release

Declaration

[Pure]
public static GitHubReleaseSettings EnablePrerelease(this GitHubReleaseSettings toolSettings)

Parameters

Type	Name	Description
GitHubReleaseSettings	toolSettings

Returns

Type	Description
GitHubReleaseSettings

ResetArtifactPaths(GitHubReleaseSettings)

Resets ArtifactPaths.

Optional file paths for files that should be appended to a release

Declaration

[Pure]
public static GitHubReleaseSettings ResetArtifactPaths(this GitHubReleaseSettings toolSettings)

Parameters

Type	Name	Description
GitHubReleaseSettings	toolSettings

Returns

Type	Description
GitHubReleaseSettings

ResetCommitSha(GitHubReleaseSettings)

Resets CommitSha.

The commit SHA on which to create the release

Declaration

[Pure]
public static GitHubReleaseSettings ResetCommitSha(this GitHubReleaseSettings toolSettings)

Parameters

Type	Name	Description
GitHubReleaseSettings	toolSettings

Returns

Type	Description
GitHubReleaseSettings

ResetName(GitHubReleaseSettings)

Resets Name.

The name of the release. If ommited, the value of is used

Declaration

[Pure]
public static GitHubReleaseSettings ResetName(this GitHubReleaseSettings toolSettings)

Parameters

Type	Name	Description
GitHubReleaseSettings	toolSettings

Returns

Type	Description
GitHubReleaseSettings

ResetPrerelease(GitHubReleaseSettings)

Resets Prerelease.

Whether this is a pre-release

Declaration

[Pure]
public static GitHubReleaseSettings ResetPrerelease(this GitHubReleaseSettings toolSettings)

Parameters

Type	Name	Description
GitHubReleaseSettings	toolSettings

Returns

Type	Description
GitHubReleaseSettings

ResetReleaseNotes(GitHubReleaseSettings)

Resets ReleaseNotes.

The message for the GitHub release

Declaration

[Pure]
public static GitHubReleaseSettings ResetReleaseNotes(this GitHubReleaseSettings toolSettings)

Parameters

Type	Name	Description
GitHubReleaseSettings	toolSettings

Returns

Type	Description
GitHubReleaseSettings

ResetTag(GitHubReleaseSettings)

Resets Tag.

The tag that should be used for the release, e.g. "v1.0.0"

Declaration

[Pure]
public static GitHubReleaseSettings ResetTag(this GitHubReleaseSettings toolSettings)

Parameters

Type	Name	Description
GitHubReleaseSettings	toolSettings

Returns

Type	Description
GitHubReleaseSettings

SetArtifactPaths(GitHubReleaseSettings, String[])

Sets ArtifactPaths.

Optional file paths for files that should be appended to a release

Declaration

[Pure]
public static GitHubReleaseSettings SetArtifactPaths(this GitHubReleaseSettings toolSettings, string[] artifactPaths)

Parameters

Type	Name	Description
GitHubReleaseSettings	toolSettings
System.String[]	artifactPaths

Returns

Type	Description
GitHubReleaseSettings

SetCommitSha(GitHubReleaseSettings, String)

Sets CommitSha.

The commit SHA on which to create the release

Declaration

[Pure]
public static GitHubReleaseSettings SetCommitSha(this GitHubReleaseSettings toolSettings, string commitSha)

Parameters

Type	Name	Description
GitHubReleaseSettings	toolSettings
System.String	commitSha

Returns

Type	Description
GitHubReleaseSettings

SetName(GitHubReleaseSettings, String)

Sets Name.

The name of the release. If ommited, the value of is used

Declaration

[Pure]
public static GitHubReleaseSettings SetName(this GitHubReleaseSettings toolSettings, string name)

Parameters

Type	Name	Description
GitHubReleaseSettings	toolSettings
System.String	name

Returns

Type	Description
GitHubReleaseSettings

SetPrerelease(GitHubReleaseSettings, Nullable<Boolean>)

Sets Prerelease.

Whether this is a pre-release

Declaration

[Pure]
public static GitHubReleaseSettings SetPrerelease(this GitHubReleaseSettings toolSettings, bool? prerelease)

Parameters

Type	Name	Description
GitHubReleaseSettings	toolSettings
System.Nullable<System.Boolean>	prerelease

Returns

Type	Description
GitHubReleaseSettings

SetReleaseNotes(GitHubReleaseSettings, String)

Sets ReleaseNotes.

The message for the GitHub release

Declaration

[Pure]
public static GitHubReleaseSettings SetReleaseNotes(this GitHubReleaseSettings toolSettings, string releaseNotes)

Parameters

Type	Name	Description
GitHubReleaseSettings	toolSettings
System.String	releaseNotes

Returns

Type	Description
GitHubReleaseSettings

SetTag(GitHubReleaseSettings, String)

Sets Tag.

The tag that should be used for the release, e.g. "v1.0.0"

Declaration

[Pure]
public static GitHubReleaseSettings SetTag(this GitHubReleaseSettings toolSettings, string tag)

Parameters

Type	Name	Description
GitHubReleaseSettings	toolSettings
System.String	tag

Returns

Type	Description
GitHubReleaseSettings

TogglePrerelease(GitHubReleaseSettings)

Toggles Prerelease.

Whether this is a pre-release

Declaration

[Pure]
public static GitHubReleaseSettings TogglePrerelease(this GitHubReleaseSettings toolSettings)

Parameters

Type	Name	Description
GitHubReleaseSettings	toolSettings

Returns

Type	Description
GitHubReleaseSettings