view_releases: View releases within a repository

In ChadGoymer/githapi: User-friendly access to the GitHub API for R

Description

view_releases() summarises releases in a table with the properties as columns and a row for each release in the repository. view_release() returns a list of all properties for a single release. browse_release() opens the web page for the release in the default browser.

Usage

view_releases(repo, n_max = 1000, ...)

view_release(release, repo, ...)

browse_release(release, repo, ...)

Arguments

repo	(string) The repository specified in the format: owner/repo.
n_max	(integer, optional) Maximum number to return. Default: 1000.
...	Parameters passed to gh_page() or gh_request().
release	(string) The id or tag of the release.

Details

For more details see the GitHub API documentation:

• https://docs.github.com/en/rest/reference/repos#list-releases

• https://docs.github.com/en/rest/reference/repos#get-a-release

• https://docs.github.com/en/rest/reference/repos#get-a-release-by-tag-name

Value

view_releases() returns a tibble of release properties. view_release() returns a list of properties for a single release. browse_release opens the default browser on the release page and returns the URL.

Release Properties:

• id: The id of the release.

• tag: The tags associated with the release.

• name: The name of the release.

• body: The description of the release.

• commit: The commit associated with the release.

• draft: Whether the release is draft.

• prerelease: Whether it is a pre-release.

• author_login: The author's account login.

• assets: The name of the assets associated with the release.

• html_url: The address of the release's web page.

• created_at: The time and date the release was created.

• published_at: The time and date the release was published.

Examples

## Not run: 

  # View all releases in a repository
  view_releases("ChadGoymer/githapi")

  # View a single release
  view_release("1.0.1", "ChadGoymer/githapi")

  # Browse the release web page
  browse_release("1.0.1", "ChadGoymer/githapi")


## End(Not run)

ChadGoymer/githapi documentation built on Oct. 22, 2021, 10:56 a.m.