github_commits: Get all information on the commits for a specified SHA or...

Description Usage Arguments Details Value

View source: R/repositories.R

Description

This function returns useful information about the history of commits for the SHA or branch specified. If extended = FALSE a tibble with the columns "sha", date", "author_name", "author_email", "committer_name", "committer_email", "message" and "url" is returned with a row for each commit in the history. If extended = TRUE the the tibble contains the columns "sha", date", "author_name", "author_email", "committer_name", "committer_email", "message", "url" and "files". The "files" column contains a tibble for each row with the columns "filename", "status", "additions", "deletions", "changes" and "contents_url", detailing the files that have been changed in the commit.

Usage

1
2
github_commits(sha, repo, path, author, since, until, extended = FALSE,
  api = getOption("github.api"), ...)

Arguments

sha

(string, optional) SHA or branch to start listing commits from. Default: the repository<e2><80><99>s default branch (usually master).

repo

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

path

(string, optional) Only commits containing this file path will be returned.

author

(string, optional) GitHub login or email address by which to filter by commit author.

since

(string, optional) Only commits after this date will be returned. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

until

(string, optional) Only commits before this date will be returned. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

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 commit. This may impact performance of the function considerably depending on the number of commits.

Value

A tibble with the columns "sha", date", "author_name", "author_email", "committer_name", "committer_email", "message" and "url". If extended = TRUE the column "files" is added.


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