1GH-RELEASE-EDIT(1) GitHub CLI manual GH-RELEASE-EDIT(1)
2
3
4
6 gh-release-edit - Edit a release
7
8
9
11 gh release edit <tag>
12
13
14
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 -n, --notes <string>
26 Release notes
27
28
29 -F, --notes-file <file>
30 Read release notes from file (use "-" to read from standard in‐
31 put)
32
33
34 --prerelease
35 Mark the release as a prerelease
36
37
38 --tag <string>
39 The name of the tag
40
41
42 --target <branch>
43 Target branch or full commit SHA (default: main branch)
44
45
46 -t, --title <string>
47 Release title
48
49
50
52 -R, --repo <[HOST/]OWNER/REPO>
53 Select another repository using the [HOST/]OWNER/REPO format
54
55
56
58 Publish a release that was previously a draft
59 $ gh release edit v1.0 --draft=false
60
61 Update the release notes from the content of a file
62 $ gh release edit v1.0 --notes-file /path/to/release_notes.md
63
64
65
66
67
69 gh-release(1)
70
71
72
73 Jun 2022 GH-RELEASE-EDIT(1)