Scroll to navigation

GH-RELEASE-EDIT(1) GitHub CLI manual GH-RELEASE-EDIT(1)

NAME

gh-release-edit - Edit a release

SYNOPSIS

gh release edit <tag>

OPTIONS

Start a discussion in the specified category when publishing a draft

Save the release as a draft instead of publishing it

Explicitly mark the release as "Latest"

Release notes

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

Mark the release as a prerelease

The name of the tag

Target branch or full commit SHA (default [main branch])

Release title

Abort in case the git tag doesn't already exist in the remote repository

OPTIONS INHERITED FROM PARENT COMMANDS

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)

Jul 2024 GitHub CLI v2.53.0