gh_release: Get a single release

Description Usage Arguments Details Value

View source: R/repositories-deprecated.R

Description

NOTE: This function has been deprecated, please use view_releases() instead.

Usage

1
gh_release(tag, repo, token = gh_token(), api = getOption("github.api"), ...)

Arguments

tag

(string, optional) The tag associated with a release. If not supplied the latest release is returned.

repo

(string) The repository specified in the format: owner/repo.

token

(string, optional) The personal access token for GitHub authorisation. Default: value stored in the environment variable GITHUB_TOKEN or GITHUB_PAT.

api

(string, optional) The URL of GitHub's API. Default: the value stored in the environment variable GITHUB_API or https://api.github.com.

...

Parameters passed to gh_get().

Details

https://developer.github.com/v3/repos/releases/#get-a-single-release https://developer.github.com/v3/repos/releases/#get-the-latest-release https://developer.github.com/v3/repos/releases/#get-a-release-by-tag-name

Value

A list describing the release (see GitHub's API documentation for details).


ChadGoymer/githapi documentation built on March 28, 2020, 11:36 p.m.