1hub-release(1) hub manual hub-release(1)
2
3
4
6 hub-release - Manage GitHub Releases for the current repository.
7
9 hub release [--include-drafts] [--exclude-prereleases] [-L LIMIT] [-f
10 FORMAT]
11 hub release show [-f FORMAT] TAG
12 hub release create [-dpoc] [-a FILE] [-m MESSAGE|-F FILE] [-t TARGET]
13 TAG
14 hub release edit [options] TAG
15 hub release download TAG
16 hub release delete TAG
17
19 With no arguments, shows a list of existing releases.
20
21 With --include-drafts, include draft releases in the listing. With
22 --exclude-prereleases, exclude non-stable releases from the listing.
23
24 show
25 Show GitHub release notes for TAG.
26
27 With --show-downloads, include the "Downloads" section.
28
29 create
30 Create a GitHub release for the specified TAG name. If git tag TAG
31 does not exist, it will be created at TARGET (default: current
32 branch).
33
34 edit
35 Edit the GitHub release for the specified TAG name. Accepts the
36 same options as create command. Publish a draft with --draft=false.
37
38 Without --message or --file, a text editor will open pre-populated
39 with the current release title and body. To re-use existing title
40 and body unchanged, pass -m "".
41
42 download
43 Download the assets attached to release for the specified TAG.
44
45 delete
46 Delete the release and associated assets for the specified TAG.
47 Note that this does not remove the git tag TAG.
48
50 -L, --limit
51 Display only the first LIMIT releases.
52
53 -d, --draft
54 Create a draft release.
55
56 -p, --prerelease
57 Create a pre-release.
58
59 -a, --attach FILE
60 Attach a file as an asset for this release.
61
62 If FILE is in the "filename#text" format, the text after the #
63 character is taken as asset label.
64
65 -m, --message MESSAGE
66 The text up to the first blank line in MESSAGE is treated as the
67 release title, and the rest is used as release description in
68 Markdown format.
69
70 When multiple --message are passed, their values are concatenated
71 with a blank line in-between.
72
73 When neither --message nor --file were supplied to release create,
74 a text editor will open to author the title and description in.
75
76 -F, --file FILE
77 Read the release title and description from FILE. Pass "-" to read
78 from standard input instead. See --message for the formatting
79 rules.
80
81 -e, --edit
82 Open the release title and description in a text editor before
83 submitting. This can be used in combination with --message or
84 --file.
85
86 -o, --browse
87 Open the new release in a web browser.
88
89 -c, --copy
90 Put the URL of the new release to clipboard instead of printing it.
91
92 -t, --commitish TARGET
93 A commit SHA or branch name to attach the release to, only used if
94 TAG does not already exist (default: main branch).
95
96 -f, --format FORMAT
97 Pretty print releases using FORMAT (default: "%T%n"). See the
98 "PRETTY FORMATS" section of git-log(1) for some additional details
99 on how placeholders are used in format. The available placeholders
100 for issues are:
101
102 %U: the URL of this release
103
104 %uT: tarball URL
105
106 %uZ: zipball URL
107
108 %uA: asset upload URL
109
110 %S: state (i.e. "draft", "pre-release")
111
112 %sC: set color to yellow or red, depending on state
113
114 %t: release name
115
116 %T: release tag
117
118 %b: body
119
120 %as: the list of assets attached to this release
121
122 %cD: created date-only (no time of day)
123
124 %cr: created date, relative
125
126 %ct: created date, UNIX timestamp
127
128 %cI: created date, ISO 8601 format
129
130 %pD: published date-only (no time of day)
131
132 %pr: published date, relative
133
134 %pt: published date, UNIX timestamp
135
136 %pI: published date, ISO 8601 format
137
138 %n: newline
139
140 %%: a literal %
141
142 --color[=WHEN]
143 Enable colored output even if stdout is not a terminal. WHEN can be
144 one of "always" (default for --color), "never", or "auto"
145 (default).
146
147 TAG
148 The git tag name for this release.
149
151 hub(1), git-tag(1)
152
153
154
155
156hub version 2.12.8 03 Oct 2019 hub-release(1)