gh-release-edit - Man Page

Edit a release

Synopsis

gh release edit <tag>

Options

--discussion-category <string>

Start a discussion in the specified category when publishing a draft

--draft

Save the release as a draft instead of publishing it

-n,  --notes <string>

Release notes

-F,  --notes-file <file>

Read release notes from file (use "-" to read from standard input)

--prerelease

Mark the release as a prerelease

--tag <string>

The name of the tag

--target <branch>

Target branch or full commit SHA (default: main branch)

-t,  --title <string>

Release title

Options Inherited from Parent Commands

-R,  --repo <[HOST/]OWNER/REPO>

Select another repository using the [HOST/]OWNER/REPO format

Example

Publish a release that was previously a draft
$ gh release edit v1.0 --draft=false

Update the release notes from the content of a file
$ gh release edit v1.0 --notes-file /path/to/release_notes.md

See Also

gh-release(1)

Referenced By

gh-release(1).

Sep 2022 GitHub CLI manual