view_statuses: View statuses of a commit within a repository

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

Description

view_statuses() summarises statuses in a table with the properties as columns and a row for each status for the specified commit in the repository. view_status() returns the combined state of all statuses for the commit.

Usage

view_statuses(ref, repo, n_max = 1000, ...)

view_status(ref, repo, ...)

Arguments

ref	(string) Either a SHA, branch or tag used to identify the commit.
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().

Details

For more details see the GitHub API documentation:

• https://docs.github.com/en/rest/reference/repos#list-commit-statuses-for-a-reference

• https://docs.github.com/en/rest/reference/repos#get-the-combined-status-for-a-specific-reference

Value

view_statuses() returns a tibble of status properties. view_status() returns a string for combined status.

Status Properties:

• id: The id of the status.

• state: The state of the status.

• description: The description of the status.

• target_url: The URL linked to the status.

• context: The context of the status.

• creator: The creator of the status.

• created_at: When it was created.

• updated_at: When it was last updated.

Examples

## Not run: 

  # View all statuses for a commit in a repository
  view_statuses("main", "ChadGoymer/githapi")

  # View the combined status
  view_status("main", "ChadGoymer/githapi")


## End(Not run)

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