1hub-release(1)                    hub manual                    hub-release(1)
2
3
4

NAME

6       hub-release - Manage GitHub Releases for the current repository.
7

SYNOPSIS

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 [-i PATTERN]
16       hub release delete TAG
17

COMMANDS

19       With no arguments, shows a list of existing releases.
20
21       show
22           Show GitHub release notes for TAG.
23
24           With --show-downloads, include the "Downloads" section.
25
26       create
27           Create a GitHub release for the specified TAG name. If git tag TAG
28           does not exist, it will be created at TARGET (default: current
29           branch).
30
31       edit
32           Edit the GitHub release for the specified TAG name. Accepts the
33           same options as create command. Publish a draft with --draft=false.
34
35           Without --message or --file, a text editor will open pre-populated
36           with the current release title and body. To re-use existing title
37           and body unchanged, pass -m "".
38
39       download
40           Download the assets attached to release for the specified TAG.
41
42       delete
43           Delete the release and associated assets for the specified TAG.
44           Note that this does not remove the git tag TAG.
45

OPTIONS

47       -d, --include-drafts
48           List drafts together with published releases.
49
50       -p, --exclude-prereleases
51           Exclude prereleases from the list.
52
53       -L, --limit
54           Display only the first LIMIT releases.
55
56       -d, --draft
57           Create a draft release.
58
59       -p, --prerelease
60           Create a pre-release.
61
62       -a, --attach FILE
63           Attach a file as an asset for this release.
64
65           If FILE is in the "filename#text" format, the text after the "#"
66           character is taken as asset label.
67
68       -m, --message MESSAGE
69           The text up to the first blank line in MESSAGE is treated as the
70           release title, and the rest is used as release description in
71           Markdown format.
72
73           When multiple --message are passed, their values are concatenated
74           with a blank line in-between.
75
76           When neither --message nor --file were supplied to release create,
77           a text editor will open to author the title and description in.
78
79       -F, --file FILE
80           Read the release title and description from FILE. Pass "-" to read
81           from standard input instead. See --message for the formatting
82           rules.
83
84       -e, --edit
85           Open the release title and description in a text editor before
86           submitting.  This can be used in combination with --message or
87           --file.
88
89       -o, --browse
90           Open the new release in a web browser.
91
92       -c, --copy
93           Put the URL of the new release to clipboard instead of printing it.
94
95       -t, --commitish TARGET
96           A commit SHA or branch name to attach the release to, only used if
97           TAG does not already exist (default: main branch).
98
99       -i, --include PATTERN
100           Filter the files in the release to those that match the glob
101           PATTERN.
102
103       -f, --format FORMAT
104           Pretty print releases using FORMAT (default: "%T%n"). See the
105           "PRETTY FORMATS" section of git-log(1) for some additional details
106           on how placeholders are used in format. The available placeholders
107           for issues are:
108
109           %U: the URL of this release
110
111           %uT: tarball URL
112
113           %uZ: zipball URL
114
115           %uA: asset upload URL
116
117           %S: state (i.e. "draft", "pre-release")
118
119           %sC: set color to yellow or red, depending on state
120
121           %t: release name
122
123           %T: release tag
124
125           %b: body
126
127           %as: the list of assets attached to this release
128
129           %cD: created date-only (no time of day)
130
131           %cr: created date, relative
132
133           %ct: created date, UNIX timestamp
134
135           %cI: created date, ISO 8601 format
136
137           %pD: published date-only (no time of day)
138
139           %pr: published date, relative
140
141           %pt: published date, UNIX timestamp
142
143           %pI: published date, ISO 8601 format
144
145           %n: newline
146
147           %%: a literal %
148
149       --color[=WHEN]
150           Enable colored output even if stdout is not a terminal. WHEN can be
151           one of "always" (default for --color), "never", or "auto"
152           (default).
153
154       TAG
155           The git tag name for this release.
156

SEE ALSO

158       hub(1), git-tag(1)
159
160
161
162
163hub version 2.14.2                20 Jul 2023                   hub-release(1)
Impressum