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/REPO format, 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 🧚


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