get_pull_request_commits: Gets a data frame of the commits of a pull request

Description Usage Arguments Value

View source: R/pull_request_commits.R

Description

Gets a data frame of the commits of a pull request

Usage

1
2
3
4
5
6
7
8
get_pull_request_commits(
  org,
  repo,
  number,
  pages = NULL,
  .cc = FALSE,
  .api_url = api_url()
)

Arguments

org

Name of organization to query

repo

Name of repository to query

number

Pull Request number

pages

Number of pages to paginate and pull data from. Each page will contain upto 100 issues/pullrequests. Defaults to NULL for all pages.

.cc

Parse the commits as conventional commits. Defaults to FALSE.

.api_url

Optional API url to query. Defaults to the value set by ‘api_url()'. Usually it’s "https://api.github.com/graphql"

Value

A data frame containing the oid | message | author | date of each commit of a pull request. If .cc = TRUE, the data frame will contain oid | type | description | body | footer | author | date


metrumresearchgroup/ghpm documentation built on Jan. 24, 2021, 8:28 p.m.