gh_commits: List commits on a repository

Description Usage Arguments Value

View source: R/repositories.R

Description

https://developer.github.com/v3/repos/commits/#list-commits-on-a-repository

Usage

1
2
gh_commits(sha, repo, path, author, since, until,
  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.

api

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

...

Parameters passed to gh_page.

Value

A list where each element describes a commit (see GitHub's API documentation for details).


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