Class GitHubReleaseSettings

Used within GitHubTasks.

Inheritance
System.Object
Nuke.Common.Tooling.ToolSettings
GitHubSettings
GitHubReleaseSettings
Implements
Nuke.Common.Tooling.ISettingsEntity
Inherited Members
Nuke.Common.Tooling.ToolSettings.GetArguments()
Nuke.Common.Tooling.ToolSettings.HasValidToolPath()
Nuke.Common.Tooling.ToolSettings.ConfigureArguments(Nuke.Common.Tooling.Arguments)
Nuke.Common.Tooling.ToolSettings.GetArgumentsInternal()
Nuke.Common.Tooling.ToolSettings.ToString()
Nuke.Common.Tooling.ToolSettings.ToolPath
Nuke.Common.Tooling.ToolSettings.WorkingDirectory
Nuke.Common.Tooling.ToolSettings.EnvironmentVariables
Nuke.Common.Tooling.ToolSettings.ExecutionTimeout
Nuke.Common.Tooling.ToolSettings.LogOutput
Nuke.Common.Tooling.ToolSettings.ArgumentConfigurator
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)
Namespace: Nuke.GitHub
Assembly: Nuke.GitHub.dll
Syntax
[PublicAPI]
[Serializable]
public class GitHubReleaseSettings : GitHubSettings, ISettingsEntity

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

Methods

| Improve this Doc View Source

AssertValid()

Declaration
protected override void AssertValid()
Overrides

Implements

Nuke.Common.Tooling.ISettingsEntity

Extension Methods