.TH "hub-release" "1" "18 Oct 2023" "hub version 2.14.2" "hub manual"
.nh
.ad l
.SH "NAME"
hub\-release \- Manage GitHub Releases for the current repository.
.SH "SYNOPSIS"
.P
\fB\fChub release\fR [\-\-include\-drafts] [\-\-exclude\-prereleases] [\-L \fILIMIT\fP] [\-f \fIFORMAT\fP]
.br
\fB\fChub release\fR show [\-f \fIFORMAT\fP] \fITAG\fP
.br
\fB\fChub release\fR create [\-dpoc] [\-a \fIFILE\fP] [\-m \fIMESSAGE\fP|\-F \fIFILE\fP] [\-t \fITARGET\fP] \fITAG\fP
.br
\fB\fChub release\fR edit [\fIoptions\fP] \fITAG\fP
.br
\fB\fChub release\fR download \fITAG\fP [\-i \fIPATTERN\fP]
.br
\fB\fChub release\fR delete \fITAG\fP
.SH "COMMANDS"
.P
With no arguments, shows a list of existing releases.
.PP
\fIshow\fP
.RS 4
Show GitHub release notes for \fITAG\fP.
.sp
With \fB\fC\-\-show\-downloads\fR, include the "Downloads" section.
.RE
.PP
\fIcreate\fP
.RS 4
Create a GitHub release for the specified \fITAG\fP name. If git tag \fITAG\fP
does not exist, it will be created at \fITARGET\fP (default: current branch).
.RE
.PP
\fIedit\fP
.RS 4
Edit the GitHub release for the specified \fITAG\fP name. Accepts the same
options as \fIcreate\fP command. Publish a draft with \fB\fC\-\-draft=false\fR.
.sp
Without \fB\fC\-\-message\fR or \fB\fC\-\-file\fR, a text editor will open pre\-populated with
the current release title and body. To re\-use existing title and body
unchanged, pass \fB\fC\-m ""\fR.
.RE
.PP
\fIdownload\fP
.RS 4
Download the assets attached to release for the specified \fITAG\fP.
.RE
.PP
\fIdelete\fP
.RS 4
Delete the release and associated assets for the specified \fITAG\fP. Note that
this does \fBnot\fP remove the git tag \fITAG\fP.
.RE
.br
.SH "OPTIONS"
.PP
\-d, \-\-include\-drafts
.RS 4
List drafts together with published releases.
.RE
.PP
\-p, \-\-exclude\-prereleases
.RS 4
Exclude prereleases from the list.
.RE
.PP
\-L, \-\-limit
.RS 4
Display only the first \fILIMIT\fP releases.
.RE
.PP
\-d, \-\-draft
.RS 4
Create a draft release.
.RE
.PP
\-p, \-\-prerelease
.RS 4
Create a pre\-release.
.RE
.PP
\-a, \-\-attach \fIFILE\fP
.RS 4
Attach a file as an asset for this release.
.sp
If \fIFILE\fP is in the "\fIfilename\fP#\fItext\fP" format, the text after the "#"
character is taken as asset label.
.RE
.PP
\-m, \-\-message \fIMESSAGE\fP
.RS 4
The text up to the first blank line in \fIMESSAGE\fP is treated as the release
title, and the rest is used as release description in Markdown format.
.sp
When multiple \fB\fC\-\-message\fR are passed, their values are concatenated with a
blank line in\-between.
.sp
When neither \fB\fC\-\-message\fR nor \fB\fC\-\-file\fR were supplied to \fB\fCrelease create\fR, a
text editor will open to author the title and description in.
.RE
.PP
\-F, \-\-file \fIFILE\fP
.RS 4
Read the release title and description from \fIFILE\fP. Pass "\-" to read from
standard input instead. See \fB\fC\-\-message\fR for the formatting rules.
.RE
.PP
\-e, \-\-edit
.RS 4
Open the release title and description in a text editor before submitting.
This can be used in combination with \fB\fC\-\-message\fR or \fB\fC\-\-file\fR.
.RE
.PP
\-o, \-\-browse
.RS 4
Open the new release in a web browser.
.RE
.PP
\-c, \-\-copy
.RS 4
Put the URL of the new release to clipboard instead of printing it.
.RE
.PP
\-t, \-\-commitish \fITARGET\fP
.RS 4
A commit SHA or branch name to attach the release to, only used if \fITAG\fP
does not already exist (default: main branch).
.RE
.PP
\-i, \-\-include \fIPATTERN\fP
.RS 4
Filter the files in the release to those that match the glob \fIPATTERN\fP.
.RE
.PP
\-f, \-\-format \fIFORMAT\fP
.RS 4
Pretty print releases using \fIFORMAT\fP (default: "%T%n"). See the "PRETTY
FORMATS" section of git\-log(1) for some additional details on how
placeholders are used in format. The available placeholders for issues are:
.sp
%U: the URL of this release
.sp
%uT: tarball URL
.sp
%uZ: zipball URL
.sp
%uA: asset upload URL
.sp
%S: state (i.e. "draft", "pre\-release")
.sp
%sC: set color to yellow or red, depending on state
.sp
%t: release name
.sp
%T: release tag
.sp
%b: body
.sp
%as: the list of assets attached to this release
.sp
%cD: created date\-only (no time of day)
.sp
%cr: created date, relative
.sp
%ct: created date, UNIX timestamp
.sp
%cI: created date, ISO 8601 format
.sp
%pD: published date\-only (no time of day)
.sp
%pr: published date, relative
.sp
%pt: published date, UNIX timestamp
.sp
%pI: published date, ISO 8601 format
.sp
%n: newline
.sp
%%: a literal %
.RE
.PP
\-\-color[=\fIWHEN\fP]
.RS 4
Enable colored output even if stdout is not a terminal. \fIWHEN\fP can be one
of "always" (default for \fB\fC\-\-color\fR), "never", or "auto" (default).
.RE
.PP
\fITAG\fP
.RS 4
The git tag name for this release.
.RE
.br
.SH "SEE ALSO"
.P
hub(1), git\-tag(1)