github_branches: Get information about all the head commits in each branch.

Description Usage Arguments Details Value

View source: R/repositories.R

Description

This function returns useful information about the head commits of each branch in the repository. If extended = FALSE a tibble with the columns "branch", "sha" and "url" is returned with a row for each branch. If extended = TRUE the the tibble contains the columns "branch", "sha", date", "author_name", "author_email", "committer_name", "committer_email", "message" and "url".

Usage

1
github_branches(repo, extended = FALSE, api = getOption("github.api"), ...)

Arguments

repo

(string) The repository specified as "owner/repo".

extended

(logical, optional) Whether to return extended results. Default: FALSE.

api

(string, optional) The address to GitHub's API. Default: Uses the option github.api.

...

Parameters passed to gh_page.

Details

Note: Extended results requires an separate API call for every required branch. This may impact performance of the function considerably depending on the number of branches.

Value

A tibble with columns "branch", "sha" and "url". When extended = TRUE the columns "date", "author_name", "author_email", "committer_name", "committer_email" and "message" are added.


ChadGoymer/github documentation built on June 1, 2017, 5:17 p.m.