1GH-RELEASE-EDIT(1)             GitHub CLI manual            GH-RELEASE-EDIT(1)
2
3
4

NAME

6       gh-release-edit - Edit a release
7
8
9

SYNOPSIS

11       gh release edit <tag>
12
13
14

OPTIONS

16       --discussion-category <string>
17              Start  a  discussion in the specified category when publishing a
18              draft
19
20
21       --draft
22              Save the release as a draft instead of publishing it
23
24
25       --latest
26              Explicitly mark the release as "Latest"
27
28
29       -n, --notes <string>
30              Release notes
31
32
33       -F, --notes-file <file>
34              Read release notes from file (use "-" to read from standard  in‐
35              put)
36
37
38       --prerelease
39              Mark the release as a prerelease
40
41
42       --tag <string>
43              The name of the tag
44
45
46       --target <branch>
47              Target branch or full commit SHA (default: main branch)
48
49
50       -t, --title <string>
51              Release title
52
53
54       --verify-tag
55              Abort  in  case  the git tag doesn't already exist in the remote
56              repository
57
58
59

OPTIONS INHERITED FROM PARENT COMMANDS

61       -R, --repo <[HOST/]OWNER/REPO>
62              Select another repository using the [HOST/]OWNER/REPO format
63
64
65

EXAMPLE

67       Publish a release that was previously a draft
68       $ gh release edit v1.0 --draft=false
69
70       Update the release notes from the content of a file
71       $ gh release edit v1.0 --notes-file /path/to/release_notes.md
72
73
74
75
76

SEE ALSO

78       gh-release(1)
79
80
81
82                                   Nov 2023                 GH-RELEASE-EDIT(1)