name | example | route | scope | type |
---|---|---|---|---|
Update a release |
octokit.rest.repos.updateRelease({ owner, repo, release_id }) |
PATCH /repos/{owner}/{repo}/releases/{release_id} |
repos |
API method |
Users with push access to the repository can edit a release.
octokit.rest.repos.updateRelease({
owner,
repo,
release_id,
});
name | required | description |
---|---|---|
owner | yes |
The account owner of the repository. The name is not case sensitive. |
repo | yes |
The name of the repository without the |
release_id | yes |
The unique identifier of the release. |
tag_name | no |
The name of the tag. |
target_commitish | no |
Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch. |
name | no |
The name of the release. |
body | no |
Text describing the contents of the tag. |
draft | no |
|
prerelease | no |
|
make_latest | no |
Specifies whether this release should be set as the latest release for the repository. Drafts and prereleases cannot be set as latest. Defaults to |
discussion_category_name | no |
If specified, a discussion of the specified category is created and linked to the release. The value must be a category that already exists in the repository. If there is already a discussion linked to the release, this parameter is ignored. For more information, see "Managing categories for discussions in your repository." |
See also: GitHub Developer Guide documentation.