Skip to content

Latest commit

 

History

History
90 lines (62 loc) · 2.56 KB

updateRelease.md

File metadata and controls

90 lines (62 loc) · 2.56 KB
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

Update a release

Users with push access to the repository can edit a release.

octokit.rest.repos.updateRelease({
  owner,
  repo,
  release_id,
});

Parameters

name required description
owneryes

The account owner of the repository. The name is not case sensitive.

repoyes

The name of the repository without the .git extension. The name is not case sensitive.

release_idyes

The unique identifier of the release.

tag_nameno

The name of the tag.

target_commitishno

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.

nameno

The name of the release.

bodyno

Text describing the contents of the tag.

draftno

true makes the release a draft, and false publishes the release.

prereleaseno

true to identify the release as a prerelease, false to identify the release as a full release.

make_latestno

Specifies whether this release should be set as the latest release for the repository. Drafts and prereleases cannot be set as latest. Defaults to true for newly published releases. legacy specifies that the latest release should be determined based on the release creation date and higher semantic version.

discussion_category_nameno

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.