view_tags: View tags within a repository

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

Description

view_tags() summarises tags in a table with the properties as columns and a row for each tag in the repository. view_tag() returns a list of all properties for a single tag.

Usage

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

view_tag(tag, 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().
tag	(string) The name of the tag.

Details

For more details see the GitHub API documentation:

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

Value

view_tags() returns a tibble of tag properties. view_tag() returns a list of properties for a single tag.

Tag Properties:

• name: The name of the tag.

• sha: The commit SHA the tag is pointing at.

• html_url: The address of the tag's web page in GitHub.

• zip_url: The address to download a zip file of the commit.

• tar_url: The address to download a tar file of the commit.

Examples

## Not run: 

  # View all tags in a repository
  view_tags("ChadGoymer/githapi")

  # View a single tag
  view_tag("new-tag", "ChadGoymer/githapi")


## End(Not run)

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