mirror of
https://gitea.com/gitea/docs.git
synced 2026-11-05 17:45:46 +00:00
bircni
55c3a392a1
update_cli_docs.sh runs gt's own generator and lays the pages out for the site: one directory per command group, front matter, titles, sidebar order, fenced help text and rewritten links. --released succeeds while no series is documented. A weekly workflow proposes updates like the runner's. Signed-off-by: bircni <[email protected]>
71 lines
2.6 KiB
Markdown
71 lines
2.6 KiB
Markdown
---
|
|
sidebar_position: 2
|
|
description: "Create a release"
|
|
---
|
|
|
|
# gt release create
|
|
|
|
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
|
|
|
|
Create a release
|
|
|
|
## Synopsis
|
|
|
|
```text
|
|
Create a release for a tag, and upload the files that follow the tag as its assets. Gitea creates
|
|
the tag at --target (the default branch) when it does not exist yet. The title defaults to the tag.
|
|
|
|
gt never pushes: commits and tags that only exist in your clone are not on the server, so push them
|
|
first (git push <remote> <tag>), or pass --verify-tag to fail when the tag is not on the server yet.
|
|
```
|
|
|
|
```
|
|
gt release create [<tag>] [<file>...] [flags]
|
|
```
|
|
|
|
## Examples
|
|
|
|
```
|
|
# Create a release with notes from a file and two assets
|
|
$ gt release create v1.0.0 dist/gt-linux dist/gt-darwin --notes-file CHANGELOG.md
|
|
|
|
# Create a draft prerelease of a new tag on a branch
|
|
$ gt release create v1.1.0-rc1 --target release/1.1 --draft --prerelease --title "1.1 RC 1"
|
|
```
|
|
|
|
## Options
|
|
|
|
```
|
|
--asset strings File to upload as an asset (repeatable)
|
|
-d, --draft Save the release as a draft
|
|
-e, --editor Write release notes in an editor
|
|
-h, --help help for create
|
|
-n, --notes string Release notes
|
|
-F, --notes-file string Read release notes from a file, or - for standard input
|
|
-p, --prerelease Mark the release as a prerelease
|
|
--target string Branch or commit the tag points to, when it is new
|
|
-t, --title string Release title
|
|
--verify-tag Fail if the tag does not exist on the server yet
|
|
```
|
|
|
|
## Options inherited from parent commands
|
|
|
|
```
|
|
--cwd directory Working directory for repository discovery
|
|
--debug Log the method, URL, status, and duration of each HTTP request to stderr
|
|
--host URL Gitea instance URL, including any base path
|
|
--interactive Allow prompts with machine output
|
|
-q, --jq expression Filter JSON output using a jq expression; implies --json
|
|
--json fields[="*"] Output JSON with the specified comma-separated fields, or all fields
|
|
--no-input Disable prompts and implicit editor/browser interactions
|
|
--remote remote Git remote used for repository discovery
|
|
-R, --repo OWNER/REPO Select a repository as OWNER/REPO or URL
|
|
--sudo user Perform API requests as this user (requires an administrator account)
|
|
--user name Account name on the selected instance
|
|
-y, --yes Accept confirmations without prompting
|
|
```
|
|
|
|
## SEE ALSO
|
|
|
|
* [gt release](../release/index.md): Manage releases
|