Class GitHubReleaseSettingsExtensions

Used within GitHubTasks.

Inheritance
System.Object
GitHubReleaseSettingsExtensions
Namespace: Nuke.GitHub
Assembly: Nuke.GitHub.dll
Syntax
public static class GitHubReleaseSettingsExtensions : object

Methods

| Improve this Doc View Source

DisablePrerelease<T>(T)

Disables Prerelease

Whether this is a pre-release

Declaration
public static T DisablePrerelease<T>(this T toolSettings)
    where T : GitHubReleaseSettings
Parameters
Type Name Description
T toolSettings
Returns
Type Description
T
Type Parameters
Name Description
T
| Improve this Doc View Source

EnablePrerelease<T>(T)

Enables Prerelease

Whether this is a pre-release

Declaration
public static T EnablePrerelease<T>(this T toolSettings)
    where T : GitHubReleaseSettings
Parameters
Type Name Description
T toolSettings
Returns
Type Description
T
Type Parameters
Name Description
T
| Improve this Doc View Source

ResetArtifactPaths<T>(T)

Resets ArtifactPaths

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

Declaration
public static T ResetArtifactPaths<T>(this T toolSettings)
    where T : GitHubReleaseSettings
Parameters
Type Name Description
T toolSettings
Returns
Type Description
T
Type Parameters
Name Description
T
| Improve this Doc View Source

ResetCommitSha<T>(T)

Resets CommitSha

The commit SHA on which to create the release

Declaration
public static T ResetCommitSha<T>(this T toolSettings)
    where T : GitHubReleaseSettings
Parameters
Type Name Description
T toolSettings
Returns
Type Description
T
Type Parameters
Name Description
T
| Improve this Doc View Source

ResetName<T>(T)

Resets Name

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

Declaration
public static T ResetName<T>(this T toolSettings)
    where T : GitHubReleaseSettings
Parameters
Type Name Description
T toolSettings
Returns
Type Description
T
Type Parameters
Name Description
T
| Improve this Doc View Source

ResetPrerelease<T>(T)

Resets Prerelease

Whether this is a pre-release

Declaration
public static T ResetPrerelease<T>(this T toolSettings)
    where T : GitHubReleaseSettings
Parameters
Type Name Description
T toolSettings
Returns
Type Description
T
Type Parameters
Name Description
T
| Improve this Doc View Source

ResetReleaseNotes<T>(T)

Resets ReleaseNotes

The message for the GitHub release

Declaration
public static T ResetReleaseNotes<T>(this T toolSettings)
    where T : GitHubReleaseSettings
Parameters
Type Name Description
T toolSettings
Returns
Type Description
T
Type Parameters
Name Description
T
| Improve this Doc View Source

ResetTag<T>(T)

Resets Tag

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

Declaration
public static T ResetTag<T>(this T toolSettings)
    where T : GitHubReleaseSettings
Parameters
Type Name Description
T toolSettings
Returns
Type Description
T
Type Parameters
Name Description
T
| Improve this Doc View Source

SetArtifactPaths<T>(T, String[])

Sets ArtifactPaths

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

Declaration
public static T SetArtifactPaths<T>(this T toolSettings, string[] artifactPaths)
    where T : GitHubReleaseSettings
Parameters
Type Name Description
T toolSettings
System.String[] artifactPaths
Returns
Type Description
T
Type Parameters
Name Description
T
| Improve this Doc View Source

SetCommitSha<T>(T, String)

Sets CommitSha

The commit SHA on which to create the release

Declaration
public static T SetCommitSha<T>(this T toolSettings, string commitSha)
    where T : GitHubReleaseSettings
Parameters
Type Name Description
T toolSettings
System.String commitSha
Returns
Type Description
T
Type Parameters
Name Description
T
| Improve this Doc View Source

SetName<T>(T, String)

Sets Name

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

Declaration
public static T SetName<T>(this T toolSettings, string name)
    where T : GitHubReleaseSettings
Parameters
Type Name Description
T toolSettings
System.String name
Returns
Type Description
T
Type Parameters
Name Description
T
| Improve this Doc View Source

SetPrerelease<T>(T, Nullable<Boolean>)

Sets Prerelease

Whether this is a pre-release

Declaration
public static T SetPrerelease<T>(this T toolSettings, bool? prerelease)
    where T : GitHubReleaseSettings
Parameters
Type Name Description
T toolSettings
System.Nullable<System.Boolean> prerelease
Returns
Type Description
T
Type Parameters
Name Description
T
| Improve this Doc View Source

SetReleaseNotes<T>(T, String)

Sets ReleaseNotes

The message for the GitHub release

Declaration
public static T SetReleaseNotes<T>(this T toolSettings, string releaseNotes)
    where T : GitHubReleaseSettings
Parameters
Type Name Description
T toolSettings
System.String releaseNotes
Returns
Type Description
T
Type Parameters
Name Description
T
| Improve this Doc View Source

SetTag<T>(T, String)

Sets Tag

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

Declaration
public static T SetTag<T>(this T toolSettings, string tag)
    where T : GitHubReleaseSettings
Parameters
Type Name Description
T toolSettings
System.String tag
Returns
Type Description
T
Type Parameters
Name Description
T
| Improve this Doc View Source

TogglePrerelease<T>(T)

Toggles Prerelease

Whether this is a pre-release

Declaration
public static T TogglePrerelease<T>(this T toolSettings)
    where T : GitHubReleaseSettings
Parameters
Type Name Description
T toolSettings
Returns
Type Description
T
Type Parameters
Name Description
T