Skip to main content

releases

Overview

Namereleases
TypeResource
Idgithub.repos.releases

Fields

NameDatatypeDescription
idinteger
namestring
body_htmlstring
published_atstring
node_idstring
authorobjectSimple User
bodystring
upload_urlstring
created_atstring
prereleasebooleanWhether to identify the release as a prerelease or a full release.
target_commitishstringSpecifies the commitish value that determines where the Git tag is created from.
draftbooleantrue to create a draft (unpublished) release, false to create a published one.
zipball_urlstring
assets_urlstring
html_urlstring
tag_namestringThe name of the tag.
mentions_countinteger
discussion_urlstringThe URL of the release discussion.
assetsarray
body_textstring
tarball_urlstring
reactionsobject
urlstring

Methods

NameAccessible byRequired ParamsDescription
get_releaseSELECTowner, release_id, repoNote: This returns an upload_url key corresponding to the endpoint for uploading release assets. This key is a hypermedia resource.
get_release_by_tagSELECTowner, repo, tagGet a published release with the specified tag.
list_releasesSELECTowner, repoThis returns a list of releases, which does not include regular Git tags that have not been associated with a release. To get a list of Git tags, use the Repository Tags API.

Information about published releases are available to everyone. Only users with push access will receive listings for draft releases.
create_releaseINSERTowner, repo, data__tag_nameUsers with push access to the repository can create a release.

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See "Secondary rate limits" and "Dealing with secondary rate limits" for details.
delete_releaseDELETEowner, release_id, repoUsers with push access to the repository can delete a release.
generate_release_notesEXECowner, repo, data__tag_nameGenerate a name and body describing a release. The body content will be markdown formatted and contain information like the changes since last release and users who contributed. The generated release notes are not saved anywhere. They are intended to be generated and used when creating a new release.
update_releaseEXECowner, release_id, repoUsers with push access to the repository can edit a release.