Your company here ā€” click to reach over 10,000 unique daily visitors

gh-release-edit - Man Page

Edit a release


gh release edit <tag>


--discussion-category <string>

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"

-n, --notes <string>

Release notes

-F, --notes-file <file>

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


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


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

Options Inherited from Parent Commands

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

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


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


Referenced By


Mar 2024 GitHub CLI manual