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
16       hub release delete TAG
17

COMMANDS

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           When MESSAGE or FILE are not specified, a text editor will open
39           pre-populated with current release title and body. To re-use
40           existing title 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

OPTIONS

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           If multiple MESSAGE options are given, their values are
71           concatenated as separate paragraphs.
72
73       -F, --file FILE
74           Read the release title and description from FILE.
75
76       -e, --edit
77           Further edit the contents of FILE in a text editor before
78           submitting.
79
80       -o, --browse
81           Open the new release in a web browser.
82
83       -c, --copy
84           Put the URL of the new release to clipboard instead of printing it.
85
86       -t, --commitish TARGET
87           A commit SHA or branch name to attach the release to, only used if
88           TAG does not already exist (default: main branch).
89
90       -f, --format FORMAT
91           Pretty print releases using FORMAT (default: "%T%n"). See the
92           "PRETTY FORMATS" section of git-log(1) for some additional details
93           on how placeholders are used in format. The available placeholders
94           for issues are:
95
96           %U: the URL of this release
97
98           %uT: tarball URL
99
100           %uZ: zipball URL
101
102           %uA: asset upload URL
103
104           %S: state (i.e. "draft", "pre-release")
105
106           %sC: set color to yellow or red, depending on state
107
108           %t: release name
109
110           %T: release tag
111
112           %b: body
113
114           %as: the list of assets attached to this release
115
116           %cD: created date-only (no time of day)
117
118           %cr: created date, relative
119
120           %ct: created date, UNIX timestamp
121
122           %cI: created date, ISO 8601 format
123
124           %pD: published date-only (no time of day)
125
126           %pr: published date, relative
127
128           %pt: published date, UNIX timestamp
129
130           %pI: published date, ISO 8601 format
131
132           %n: newline
133
134           %%: a literal %
135
136       --color[=WHEN]
137           Enable colored output even if stdout is not a terminal. WHEN can be
138           one of "always" (default for --color), "never", or "auto"
139           (default).
140
141       TAG
142           The git tag name for this release.
143

SEE ALSO

145       hub(1), git-tag(1)
146
147
148
149
150hub version 2.11.1                29 Mar 2019                   hub-release(1)
Impressum