Class GitHubReleaseOptions

Namespace

Ando.Operations

Assembly

ando.dll

Options for creating a GitHub release.

public class GitHubReleaseOptions

Inheritance

object

GitHubReleaseOptions

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Properties

Draft

Create as draft release.

public bool Draft { get; }

Property Value

bool

Files

Files to upload as release assets.

public List<string> Files { get; }

Property Value

List<string>

GenerateNotes

Auto-generate release notes.

public bool GenerateNotes { get; }

Property Value

bool

NoPrefix

Don't add 'v' prefix to tag.

public bool NoPrefix { get; }

Property Value

bool

Notes

Release notes.

public string? Notes { get; }

Property Value

string

Prerelease

Mark as pre-release.

public bool Prerelease { get; }

Property Value

bool

Tag

Tag name for the release.

public string? Tag { get; }

Property Value

string

Title

Release title.

public string? Title { get; }

Property Value

string

Methods

AsDraft()

Creates as a draft release.

public GitHubReleaseOptions AsDraft()

Returns

GitHubReleaseOptions

AsPrerelease()

Marks as a pre-release.

public GitHubReleaseOptions AsPrerelease()

Returns

GitHubReleaseOptions

WithFiles(params string[])

Adds files to upload as release assets.

public GitHubReleaseOptions WithFiles(params string[] files)

Parameters

files string[]

Returns

GitHubReleaseOptions

WithGeneratedNotes()

Auto-generates release notes from commits.

public GitHubReleaseOptions WithGeneratedNotes()

Returns

GitHubReleaseOptions

WithNotes(string)

Sets the release notes.

public GitHubReleaseOptions WithNotes(string notes)

Parameters

notes string

Returns

GitHubReleaseOptions

WithTag(string)

Sets the tag name.

public GitHubReleaseOptions WithTag(string tag)

Parameters

tag string

Returns

GitHubReleaseOptions

WithTitle(string)

Sets the release title.

public GitHubReleaseOptions WithTitle(string title)

Parameters

title string

Returns

GitHubReleaseOptions

WithoutPrefix()

Don't add 'v' prefix to tag.

public GitHubReleaseOptions WithoutPrefix()

Returns

GitHubReleaseOptions