Man page - gh-release-create(1)
Packages contas this manual
- gh-project-link(1)
- gh-gist-delete(1)
- gh-project-delete(1)
- gh-codespace-create(1)
- gh-extension(1)
- gh-issue-status(1)
- gh-release-view(1)
- gh-config-clear-cache(1)
- gh-pr-checks(1)
- gh-gist-rename(1)
- gh-auth-status(1)
- gh-search-repos(1)
- gh-alias-list(1)
- gh-variable-set(1)
- gh-repo-unarchive(1)
- gh-issue-view(1)
- gh-ruleset-list(1)
- gh-repo-create(1)
- gh-secret-set(1)
- gh-repo-set-default(1)
- gh-ssh-key-list(1)
- gh-auth-switch(1)
- gh-gist-clone(1)
- gh-pr-checkout(1)
- gh-extension-exec(1)
- gh-project-item-delete(1)
- gh-pr-reopen(1)
- gh-variable(1)
- gh-gpg-key(1)
- gh-codespace-ports-forward(1)
- gh-project-item-edit(1)
- gh-browse(1)
- gh-codespace-delete(1)
- gh-project-item-list(1)
- gh-issue-reopen(1)
- gh-release-upload(1)
- gh-issue-transfer(1)
- gh-project-item-create(1)
- gh-extension-create(1)
- gh-repo-deploy-key-delete(1)
- gh-issue-comment(1)
- gh-cache-delete(1)
- gh-release(1)
- gh(1)
- gh-status(1)
- gh-org(1)
- gh-run-view(1)
- gh-repo-edit(1)
- gh-repo-deploy-key(1)
- gh-gist-view(1)
- gh-extension-upgrade(1)
- gh-extension-browse(1)
- gh-label-edit(1)
- gh-api(1)
- gh-variable-list(1)
- gh-workflow-run(1)
- gh-project-mark-template(1)
- gh-repo-deploy-key-list(1)
- gh-secret-delete(1)
- gh-workflow-list(1)
- gh-gist-list(1)
- gh-repo(1)
- gh-pr-diff(1)
- gh-pr-review(1)
- gh-workflow(1)
- gh-release-delete(1)
- gh-extension-remove(1)
- gh-codespace-cp(1)
- gh-run-list(1)
- gh-repo-sync(1)
- gh-release-list(1)
- gh-codespace-code(1)
- gh-codespace-ssh(1)
- gh-search-issues(1)
- gh-secret(1)
- gh-completion(1)
- gh-auth-token(1)
- gh-issue(1)
- gh-project-field-create(1)
- gh-gpg-key-add(1)
- gh-variable-delete(1)
- gh-label-delete(1)
- gh-alias-delete(1)
- gh-ssh-key-add(1)
- gh-repo-clone(1)
- gh-extension-search(1)
- gh-search-code(1)
- gh-alias(1)
- gh-release-edit(1)
- gh-auth-logout(1)
- gh-cache(1)
- gh-issue-pin(1)
- gh-pr-create(1)
- gh-pr-view(1)
- gh-release-download(1)
- gh-secret-list(1)
- gh-alias-import(1)
- gh-repo-rename(1)
- gh-config-get(1)
- gh-project-view(1)
- gh-project(1)
- gh-codespace-edit(1)
- gh-repo-delete(1)
- gh-run(1)
- gh-extension-install(1)
- gh-auth-login(1)
- gh-pr-status(1)
- gh-ruleset-check(1)
- gh-codespace-logs(1)
- gh-run-delete(1)
- gh-gist(1)
- gh-pr-unlock(1)
- gh-gist-create(1)
- gh-project-copy(1)
- gh-issue-list(1)
- gh-codespace-ports(1)
- gh-extension-list(1)
- gh-repo-archive(1)
- gh-issue-unlock(1)
- gh-issue-close(1)
- gh-project-item-archive(1)
- gh-project-close(1)
- gh-project-list(1)
- gh-run-cancel(1)
- gh-workflow-enable(1)
- gh-run-rerun(1)
- gh-issue-create(1)
- gh-issue-edit(1)
- gh-project-edit(1)
- gh-ssh-key(1)
- gh-gpg-key-list(1)
- gh-label-list(1)
- gh-label(1)
- gh-release-delete-asset(1)
- gh-pr-comment(1)
- gh-project-field-delete(1)
- gh-codespace-rebuild(1)
- gh-search(1)
- gh-gist-edit(1)
- gh-run-download(1)
- gh-issue-unpin(1)
- gh-repo-deploy-key-add(1)
- gh-config-set(1)
- gh-project-field-list(1)
- gh-pr-list(1)
- gh-search-commits(1)
- gh-codespace-list(1)
- gh-pr-lock(1)
- gh-pr-merge(1)
- gh-cache-list(1)
- gh-codespace-view(1)
- gh-ruleset(1)
- gh-auth-refresh(1)
- gh-workflow-disable(1)
- gh-project-unlink(1)
- gh-release-create(1)
- gh-issue-lock(1)
- gh-gpg-key-delete(1)
- gh-org-list(1)
- gh-search-prs(1)
- gh-repo-fork(1)
- gh-ssh-key-delete(1)
- gh-repo-list(1)
- gh-issue-develop(1)
- gh-project-create(1)
- gh-workflow-view(1)
- gh-codespace-ports-visibility(1)
- gh-alias-set(1)
- gh-codespace-jupyter(1)
- gh-ruleset-view(1)
- gh-label-create(1)
- gh-config-list(1)
- gh-project-item-add(1)
- gh-pr-edit(1)
- gh-pr-close(1)
- gh-issue-delete(1)
- gh-repo-view(1)
- gh-label-clone(1)
- gh-pr(1)
- gh-auth-setup-git(1)
- gh-pr-ready(1)
- gh-run-watch(1)
- gh-codespace-stop(1)
- gh-codespace(1)
- gh-config(1)
- gh-auth(1)
Package: gh
apt-get install gh
apt-get install gh
Manuals in package:
Manual
| GH-RELEASE-CREATE(1) | GitHub CLI manual | GH-RELEASE-CREATE(1) |
NAME
gh-release-create - Create a new release
SYNOPSIS
gh release create [<tag>] [<files>...]
DESCRIPTION
Create a new GitHub Release for a repository.
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 # after the file name.
If a matching git tag does not yet exist, one will automatically get created from the latest state of the default branch. Use --target to point to a different branch or commit for the automatic tag creation. Use --verify-tag to abort the release if the tag doesn't already exist. To fetch the new tag locally after the release, do git fetch --tags origin.
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 --notes-from-tag to automatically generate the release notes from the annotated git tag.
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 --notes flag.
OPTIONS
- --discussion-category <string>
- Start a discussion in the specified category
- -d, --draft
- Save the release as a draft instead of publishing it
- --generate-notes
- Automatically generate title and notes for the release
- --latest
- Mark this release as "Latest" (default [automatic based on date and version])
- -n, --notes <string>
- Release notes
- -F, --notes-file <file>
- Read release notes from file (use "-" to read from standard input)
- --notes-from-tag
- Automatically generate notes from annotated tag
- --notes-start-tag <string>
- Tag to use as the starting point for generating release notes
- -p, --prerelease
- Mark the release as a prerelease
- --target <branch>
- Target branch or full commit SHA (default [main branch])
- -t, --title <string>
- Release title
- --verify-tag
- Abort in case the git tag doesn't already exist in the remote repository
OPTIONS INHERITED FROM PARENT COMMANDS
- -R, --repo <[HOST/]OWNER/REPO>
- Select another repository using the [HOST/]OWNER/REPO format
EXAMPLE
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 changelog.md 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"
SEE ALSO
gh-release(1)
| Jan 2025 |