releases

Overview

Name	releases
Type	Resource
Id	github.repos.releases

Fields

Name	Datatype	Description
id	integer
name	string
assets	array
assets_url	string
author	object	A GitHub user.
body	string
body_html	string
body_text	string
created_at	string
discussion_url	string	The URL of the release discussion.
draft	boolean	true to create a draft (unpublished) release, false to create a published one.
html_url	string
mentions_count	integer
node_id	string
prerelease	boolean	Whether to identify the release as a prerelease or a full release.
published_at	string
reactions	object
tag_name	string	The name of the tag.
tarball_url	string
target_commitish	string	Specifies the commitish value that determines where the Git tag is created from.
upload_url	string
url	string
zipball_url	string

Methods

Name	Accessible by	Required Params	Description
get_release	SELECT	owner, release_id, repo	Note: This returns an upload_url key corresponding to the endpoint for uploading release assets. This key is a hypermedia resource.
get_release_by_tag	SELECT	owner, repo, tag	Get a published release with the specified tag.
list_releases	SELECT	owner, repo	This 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_release	INSERT	owner, repo, data__tag_name	Users 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_release	DELETE	owner, release_id, repo	Users with push access to the repository can delete a release.
generate_release_notes	EXEC	owner, repo, data__tag_name	Generate 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_release	EXEC	owner, release_id, repo	Users with push access to the repository can edit a release.