GH-RELEASE-EDIT(1)
β¨ NAME β¨
okay so bestie, this is gh-release-edit from the GitHub CLI manual β it's the glow-up command that edits a release π
(yes, you can fix your typos after publishing, we love a second chance moment)
πΈ SYNOPSIS πΈ
gh release edit <tag>
that's it, that's the whole vibe β you point it at a tag and it does the rest π
π OPTIONS π
--discussion-category <string>β when you're publishing a draft, this starts a discussion in the category you name π£οΈ--draftβ saves the release as a draft instead of publishing it, so it stays in the group chat drafts folder π--latestβ explicitly marks the release as "Latest", no cap, you're the main character now π-n,--notes <string>β the release notes, your little love letter βοΈ-F,--notes-file <file>β reads the release notes from a file instead (and if you pass"-"it reads from standard input, iconic) π--prereleaseβ marks the release as a prerelease, the "not ready for the world yet" era π±--tag <string>β the name of the tag π·οΈ--target <branch>β target branch or a full commit SHA (default is[main branch]) π―-t,--title <string>β the release title, make it cute π--verify-tagβ aborts if the git tag doesn't already exist in the remote repository, so it's the vibe-check-before-you-commit option π₯
π¦ OPTIONS INHERITED FROM PARENT COMMANDS π¦
-R,--repo <[HOST/]OWNER/REPO>β selects a different repository using the[HOST/]OWNER/REPOformat, for when you're being nosy about someone else's repo π
β EXIT CODES β
0: Successful execution β slay, it worked π1: Error β it's giving chaos π2: Command canceled β you backed out, no judgement π«Ά4: Authentication required β log in first bestie π
NOTE: specific commands may have additional exit codes. Refer to the command's help for more information π
π 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
look at that β one flag flips a draft into a full published release, and the other pulls your notes straight out of a file. ate and left no crumbs πβ¨
π§ SEE ALSO π§
gh-release(1)β go read the big one, iykyk π
and that's the whole page bestie!! this was GitHub CLI v2.102.0, dated Oct 2026 β fr fr, go edit some releases now, you're gonna do amazing πππ¦
π¦ where this page comes from
- opensuse-leap 16.0: gh 2.102.0-bp160.1.1 Β· MIT
- opensuse-leap 16.0: gh 2.102.0-bp160.1.1 Β· MIT
- opensuse-leap 16.0: gh 2.102.0-bp160.1.1 Β· MIT
- opensuse-leap 16.0: gh 2.102.0-bp160.1.1 Β· MIT
- π girlified by deepseek-ai/DeepSeek-V4.1-Flash-1017 on : a language model's rewrite of the original, under its terms