view_branches: View branches within a repository

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

Description

view_branches() summarises branches in a table with the properties as columns and a row for each branch in the repository. view_branch() returns a list of all properties for a single branch.

Usage

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

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

Details

For more details see the GitHub API documentation:

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

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

Value

view_branches() returns a tibble of branch properties. view_branch() returns a list of properties for a single branch.

Branch Properties:

• name: The name of the branch.

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

• protected: Whether the branch is protected.

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

Examples

## Not run: 

  # View all branches in a repository
  view_branches(repo = "ChadGoymer/githapi")

  # View a single branch
  view_branch(branch = "new-branch", repo = "ChadGoymer/githapi")


## End(Not run)

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