Struct ReleaseCreate 

#[non_exhaustive]
pub struct ReleaseCreate {
    pub tag: String,
    pub title: Option<String>,
    pub notes: Option<String>,
    pub draft: bool,
    pub prerelease: bool,
}

Options for GitHubApi::release_create (gh release create).

#[non_exhaustive], so build it through ReleaseCreate::new (the tag) and the chained title / notes / draft / prerelease setters rather than a struct literal. Asset uploads are deliberately out of scope — attach files with run if you need them.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

tag: String

The Git tag the release is attached to (gh’s bare <tag> positional). If no such tag exists, gh creates one from the default branch’s latest state.

title: Option<String>

The release title (--title); None lets gh default it (to the tag).

notes: Option<String>

The release notes / body (--notes); None leaves notes unset. Note that gh requires notes when run non-interactively, so a headless create should set this (or drive --notes-file/--generate-notes via run) — otherwise gh errors asking for notes.

draft: bool

Save the release as a draft instead of publishing it (--draft).

prerelease: bool

Mark the release as a prerelease (--prerelease).

Implementations

impl ReleaseCreate

pub fn new(tag: impl Into<String>) -> Self

A published release on tag, with gh’s default title/notes and neither draft nor prerelease set. Chain the setters to change any of those.

pub fn title(self, title: impl Into<String>) -> Self

Set the release title (--title).

pub fn notes(self, notes: impl Into<String>) -> Self

Set the release notes / body (--notes).

pub fn draft(self) -> Self

Save as a draft instead of publishing (--draft).

pub fn prerelease(self) -> Self

Mark the release as a prerelease (--prerelease).

Trait Implementations

impl Clone for ReleaseCreate

fn clone(&self) -> ReleaseCreate

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ReleaseCreate

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.