Show / Hide Table of Contents

    Class GitHubReleaseSettings

    Used within GitHubTasks.

    Inheritance
    System.Object
    GitHubSettings
    GitHubReleaseSettings
    Inherited Members
    GitHubSettings.CustomLogger
    GitHubSettings.Validate()
    GitHubSettings.RepositoryOwner
    GitHubSettings.RepositoryName
    GitHubSettings.Token
    GitHubSettings.Url
    Namespace: Nuke.GitHub
    Assembly: Nuke.GitHub.dll
    Syntax
    public class GitHubReleaseSettings : GitHubSettings

    Properties

    | Improve this Doc View Source

    ArtifactPaths

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

    Declaration
    public virtual string[] ArtifactPaths { get; }
    Property Value
    Type Description
    System.String[]
    | Improve this Doc View Source

    CommitSha

    The commit SHA on which to create the release

    Declaration
    public virtual string CommitSha { get; }
    Property Value
    Type Description
    System.String
    | Improve this Doc View Source

    Name

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

    Declaration
    public virtual string Name { get; }
    Property Value
    Type Description
    System.String
    | Improve this Doc View Source

    Prerelease

    Whether this is a pre-release

    Declaration
    public virtual bool? Prerelease { get; }
    Property Value
    Type Description
    System.Nullable<System.Boolean>
    | Improve this Doc View Source

    ReleaseNotes

    The message for the GitHub release

    Declaration
    public virtual string ReleaseNotes { get; }
    Property Value
    Type Description
    System.String
    | Improve this Doc View Source

    Tag

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

    Declaration
    public virtual string Tag { get; }
    Property Value
    Type Description
    System.String

    Extension Methods

    GitHubReleaseSettingsExtensions.SetArtifactPaths<T>(T, String[])
    GitHubReleaseSettingsExtensions.ResetArtifactPaths<T>(T)
    GitHubReleaseSettingsExtensions.SetReleaseNotes<T>(T, String)
    GitHubReleaseSettingsExtensions.ResetReleaseNotes<T>(T)
    GitHubReleaseSettingsExtensions.SetTag<T>(T, String)
    GitHubReleaseSettingsExtensions.ResetTag<T>(T)
    GitHubReleaseSettingsExtensions.SetName<T>(T, String)
    GitHubReleaseSettingsExtensions.ResetName<T>(T)
    GitHubReleaseSettingsExtensions.SetCommitSha<T>(T, String)
    GitHubReleaseSettingsExtensions.ResetCommitSha<T>(T)
    GitHubReleaseSettingsExtensions.SetPrerelease<T>(T, Nullable<Boolean>)
    GitHubReleaseSettingsExtensions.ResetPrerelease<T>(T)
    GitHubReleaseSettingsExtensions.EnablePrerelease<T>(T)
    GitHubReleaseSettingsExtensions.DisablePrerelease<T>(T)
    GitHubReleaseSettingsExtensions.TogglePrerelease<T>(T)
    GitHubSettingsExtensions.SetRepositoryOwner<T>(T, String)
    GitHubSettingsExtensions.ResetRepositoryOwner<T>(T)
    GitHubSettingsExtensions.SetRepositoryName<T>(T, String)
    GitHubSettingsExtensions.ResetRepositoryName<T>(T)
    GitHubSettingsExtensions.SetToken<T>(T, String)
    GitHubSettingsExtensions.ResetToken<T>(T)
    GitHubSettingsExtensions.SetUrl<T>(T, String)
    GitHubSettingsExtensions.ResetUrl<T>(T)
    • Improve this Doc
    • View Source
    Back to top © Dangl IT GmbH