6ebe3612cd
All checks were successful
Test / frontend-tests (pull_request) Successful in 1m9s
Test / frontend-typecheck (pull_request) Successful in 1m15s
Test / rust-fmt-check (pull_request) Successful in 2m44s
Test / rust-clippy (pull_request) Successful in 24m22s
Test / rust-tests (pull_request) Successful in 25m43s
- Fix TypeScript lint errors in setup.ts and LogUpload - Remove unused imports and variables - Fix duplicate Separator exports in ui/index.tsx - Apply cargo fmt formatting to Rust code - Update ESLint configuration
151 lines
3.6 KiB
Groff
151 lines
3.6 KiB
Groff
.nh
|
|
.TH "GH-RELEASE-CREATE" "1" "Nov 2024" "GitHub CLI 2.63.0" "GitHub CLI manual"
|
|
|
|
.SH NAME
|
|
gh-release-create - Create a new release
|
|
|
|
|
|
.SH SYNOPSIS
|
|
\fBgh release create [<tag>] [<files>...]\fR
|
|
|
|
|
|
.SH DESCRIPTION
|
|
Create a new GitHub Release for a repository.
|
|
|
|
.PP
|
|
A list of asset files may be given to upload to the new release. To define a
|
|
display label for an asset, append text starting with \fB#\fR after the file name.
|
|
|
|
.PP
|
|
If a matching git tag does not yet exist, one will automatically get created
|
|
from the latest state of the default branch.
|
|
Use \fB--target\fR to point to a different branch or commit for the automatic tag creation.
|
|
Use \fB--verify-tag\fR to abort the release if the tag doesn't already exist.
|
|
To fetch the new tag locally after the release, do \fBgit fetch --tags origin\fR\&.
|
|
|
|
.PP
|
|
To create a release from an annotated git tag, first create one locally with
|
|
git, push the tag to GitHub, then run this command.
|
|
Use \fB--notes-from-tag\fR to automatically generate the release notes
|
|
from the annotated git tag.
|
|
|
|
.PP
|
|
When using automatically generated release notes, a release title will also be automatically
|
|
generated unless a title was explicitly passed. Additional release notes can be prepended to
|
|
automatically generated notes by using the \fB--notes\fR flag.
|
|
|
|
|
|
.SH OPTIONS
|
|
.TP
|
|
\fB--discussion-category\fR \fB<string>\fR
|
|
Start a discussion in the specified category
|
|
|
|
.TP
|
|
\fB-d\fR, \fB--draft\fR
|
|
Save the release as a draft instead of publishing it
|
|
|
|
.TP
|
|
\fB--generate-notes\fR
|
|
Automatically generate title and notes for the release
|
|
|
|
.TP
|
|
\fB--latest\fR
|
|
Mark this release as "Latest" (default [automatic based on date and version]). --latest=false to explicitly NOT set as latest
|
|
|
|
.TP
|
|
\fB-n\fR, \fB--notes\fR \fB<string>\fR
|
|
Release notes
|
|
|
|
.TP
|
|
\fB-F\fR, \fB--notes-file\fR \fB<file>\fR
|
|
Read release notes from file (use "-" to read from standard input)
|
|
|
|
.TP
|
|
\fB--notes-from-tag\fR
|
|
Automatically generate notes from annotated tag
|
|
|
|
.TP
|
|
\fB--notes-start-tag\fR \fB<string>\fR
|
|
Tag to use as the starting point for generating release notes
|
|
|
|
.TP
|
|
\fB-p\fR, \fB--prerelease\fR
|
|
Mark the release as a prerelease
|
|
|
|
.TP
|
|
\fB--target\fR \fB<branch>\fR
|
|
Target branch or full commit SHA (default [main branch])
|
|
|
|
.TP
|
|
\fB-t\fR, \fB--title\fR \fB<string>\fR
|
|
Release title
|
|
|
|
.TP
|
|
\fB--verify-tag\fR
|
|
Abort in case the git tag doesn't already exist in the remote repository
|
|
|
|
|
|
.SH OPTIONS INHERITED FROM PARENT COMMANDS
|
|
.TP
|
|
\fB-R\fR, \fB--repo\fR \fB<[HOST/]OWNER/REPO>\fR
|
|
Select another repository using the [HOST/]OWNER/REPO format
|
|
|
|
|
|
.SH ALIASES
|
|
gh release new
|
|
|
|
|
|
.SH EXIT CODES
|
|
0: Successful execution
|
|
|
|
.PP
|
|
1: Error
|
|
|
|
.PP
|
|
2: Command canceled
|
|
|
|
.PP
|
|
4: Authentication required
|
|
|
|
.PP
|
|
NOTE: Specific commands may have additional exit codes. Refer to the command's help for more information.
|
|
|
|
|
|
.SH EXAMPLE
|
|
.EX
|
|
Interactively create a release
|
|
$ gh release create
|
|
|
|
Interactively create a release from specific tag
|
|
$ gh release create v1.2.3
|
|
|
|
Non-interactively create a release
|
|
$ gh release create v1.2.3 --notes "bugfix release"
|
|
|
|
Use automatically generated release notes
|
|
$ gh release create v1.2.3 --generate-notes
|
|
|
|
Use release notes from a file
|
|
$ gh release create v1.2.3 -F release-notes.md
|
|
|
|
Use annotated tag notes
|
|
$ gh release create v1.2.3 --notes-from-tag
|
|
|
|
Don't mark the release as latest
|
|
$ gh release create v1.2.3 --latest=false
|
|
|
|
Upload all tarballs in a directory as release assets
|
|
$ gh release create v1.2.3 ./dist/*.tgz
|
|
|
|
Upload a release asset with a display label
|
|
$ gh release create v1.2.3 '/path/to/asset.zip#My display label'
|
|
|
|
Create a release and start a discussion
|
|
$ gh release create v1.2.3 --discussion-category "General"
|
|
|
|
.EE
|
|
|
|
|
|
.SH SEE ALSO
|
|
\fBgh-release(1)\fR
|