Interface CreateReleaseData

Request body for creating a release.

See

https://docs.github.com/en/rest/releases/releases#create-a-release

interface CreateReleaseData {
    body?: string;
    draft?: boolean;
    generate_release_notes?: boolean;
    name?: string;
    prerelease?: boolean;
    tag_name: string;
    target_commitish?: string;
}

Properties

body? draft? generate_release_notes? name? prerelease? tag_name target_commitish?

Properties

Optionalbody

body?: string

Release description / changelog

Optionaldraft

draft?: boolean

Whether this is a draft release

Optionalgenerate_release_notes

generate_release_notes?: boolean

Whether to automatically generate release notes

Optionalname

name?: string

Release title

Optionalprerelease

prerelease?: boolean

Whether this is a pre-release

tag_name

tag_name: string

Tag name to create or use (e.g., 'v1.0.0')

Optionaltarget_commitish

target_commitish?: string

Commitish to tag from (branch name, SHA, etc.) — defaults to the default branch

Settings

Member Visibility

On This Page

Properties